\n\n\n\n# š Create New Branch\n\nāØ **cnb** is a simple and customizable CLI tool that helps you create Git branches following naming conventions, and validates (lints) branch names to ensure they follow the configured conventions.\n\n## š¬ Demo\n\n\n\n## š¦ Installation\n\nInstall the package as a dev dependency:\n\n```bash\nnpm i -D cnb\n```\n\n## š ļø Usage\n\n### Creating a New Branch\n\n1. Add the following alias to your `.gitconfig`:\n\n```shell\n[alias]\ncnb = \"!npx cnb\"\n```\n\n2. Add the following script to your `package.json`:\n\n```json\n\"scripts\": {\n\t\"prepare\": \"git config --local include.path ../.gitconfig\",\n}\n```\n\n3. Make sure the prepare script runs before trying the new git alias. You can do this by running (only once):\n\n```bash\nnpm i\n```\n\nOr explicitly run the script:\n\n```bash\nnpm run prepare\n```\n\n4. Run the following command to create a new branch with naming conventions:\n\n```bash\ngit cnb\n```\n\nThis will prompt you with a set of options to choose from (e.g., `feat`, `fix`, `chore`, etc.). You'll also provide a short description that will be formatted into kebab-case.\n\nExample:\n\n- Selected type: `feat`\n- Description: `configure notifications`\n\nThe branch created will be: `feat/configure-notifications`.\n\nIf your configuration requires a ticket ID (based on your config file), the flow will prompt you to enter that first.\n\n### Linting a Branch Name\n\nYou can also use **cnb** to lint and validate if the current branch name follows your configured conventions.\n\n1. Add the following script to your `package.json`:\n\n```json\n\"scripts\": {\n\t\"cnb:check\": \"cnb --check\"\n}\n```\n\n2. Run the script to lint the current branch name:\n\n```bash\nnpm run cnb:check\n```\n\n## š Configuration\n\nYou can customize the behavior of **cnb** by creating a configuration file in your project root called `cnb.config.ts` (for ES6 environments) or `cnb.config.cjs` (for CommonJS environments).\n\n### Configuration Options\n\n| Option | Type | Description | Default |\n| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------- | ----------------------------------- |\n| `branchTypes` | `string[]` | The types of branches you can select (e.g., `feat`, `fix`, `chore`, `style`) | `['feat', 'fix', 'chore', 'style']` |\n| `maxDescriptionLength` | `number` | The maximum length allowed for the branch description. | `20` |\n| `skipTicketId` | `boolean` | Whether to skip the ticket ID prompt. | `false` |\n| `ticketIdPrefix` | `string` | The prefix to add to the ticket ID (e.g., `JIRA-`). | `T-` |\n| `separator` | `string` | The character(s) used to separate the ticket ID, branch type, and branch name (e.g., `/`, `_`). | `/` |\n\n### Example `cnb.config.ts` (ES6)\n\n```ts\nimport type { CnbConfig } from 'cnb';\n\nconst config: CnbConfig = {\n\tbranchTypes: ['feat', 'fix', 'chore', 'style'],\n\tmaxDescriptionLength: 20,\n\tskipTicketId: false,\n\tticketIdPrefix: 'JIRA-',\n};\n\nexport default config;\n```\n\n### Example `cnb.config.cjs` (CommonJS)\n\n```js\nmodule.exports = {\n\tbranchTypes: ['feat', 'fix', 'chore', 'style'],\n\tmaxDescriptionLength: 20,\n\tskipTicketId: false,\n\tticketIdPrefix: 'JIRA-',\n};\n```\n\n## š ļø Note for ES6 vs. CommonJS Users\n\n- **For ES6 users**: Create your configuration file as `cnb.config.ts` and use `export default`.\n- **For CommonJS users**: Create your configuration file as `cnb.config.cjs` and use `module.exports`.\n\n## š„ Authors\n\n\n \n\n\n## š License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","readmeFilename":"README.md"}
![](\"https://github.com/amir-ben-shimol/cnb/blob/main/assets/brand.png\")
\n![\"CI](\"https://img.shields.io/github/actions/workflow/status/amir-ben-shimol/cnb/integrate.yaml?label=CI&logo=GitHub\")
![\"npm](\"https://img.shields.io/npm/dm/cnb?logo=NPM\")
![\"npm](\"https://img.shields.io/npm/l/cnb\")
![\"version\"](\"https://img.shields.io/npm/v/cnb?label=version\")
![](\"https://avatars.githubusercontent.com/u/105565954?s=400&u=01efa537bf4368251ffa05954d13aa1861073b39&v=4\")
\n\n\n## š License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","readmeFilename":"README.md"}