![\"\"](\"https://img.shields.io/npm/v/siroc/latest.svg?style=flat-square\")
\n\n\n ![\"\"](\"https://img.shields.io/npm/dt/siroc.svg?style=flat-square\")
\n\n\n ![\"\"](\"https://img.shields.io/lgtm/alerts/github/nuxt-contrib/siroc?style=flat-square\")
\n\n\n ![\"\"](\"https://img.shields.io/lgtm/grade/javascript/github/nuxt-contrib/siroc?style=flat-square\")
\n\nZero-config build tooling for Node
\n\n\n\n> `siroc` is a zero-config but extensible framework for developing Node applications and libraries\n\n## Features\n\n- 💯 **Zero-config required**: Intelligent support for your package\n - Supports running and compiling TypeScript and the latest JavaScript syntax\n - Autoconfigured `jest` and `eslint`\n- ⚒️ **Extensible**: Write your own commands and build hooks\n- 💪 **Typescript**: Fully typed and self-documenting\n\n**`siroc` is still a work in progress. Feedback is welcome, and changes will be frequent.**\n\n## Quick start\n\nJust install `siroc`.\n\n```bash\n# You can install siroc as a development dependency\nyarn add siroc --dev\n\n# ... or install globally\nyarn global add siroc\n```\n\n## Configuration\n\nYou can configure `siroc` by creating a `siroc.config.ts`, `siroc.config.js` or `siroc.config.json` file at the same level as your `package.json`.\n\nIn a monorepo, any configuration options at the root level are inherited by your workspaces, though of course you can override them.\n\n### TypeScript\n\n```ts\nimport type { PackageOptions } from 'siroc'\n\nconst config: PackageOptions = {\n // fully typed options\n}\n\nexport default config\n```\n\n### JavaScript\n\n```js\n/**\n * @type {import('siroc').PackageOptions} config\n */\nconst config = {\n // fully typed options\n}\n\nexport default config\n```\n\n## Commands\n\n### `siroc build`\n\n`siroc` knows what to build based on your `package.json`.\n\nBy default, `siroc` will build your `src/index.js` or `src/index.ts` file into whatever output file is specified in your package.json's `main` field.\n\nIf you have specified additional binaries, `siroc` will look for input files matching their names.\n\nUnder the hood, `siroc` uses `rollup` and `esbuild` to build and produce type definitions for your files.\n\n#### Monorepos\n\nIf you have enabled yarn workspaces, siroc will build each of your workspaces. You can choose to build only some of these by specifying what to build.\n\n```bash\nyarn siroc build @mypackage/cli\n```\n\n#### Watch mode\n\nYou can build in watch mode, which will rebuild as necessary when source files change:\n\n```\nyarn siroc build --watch\n```\n\n#### Configuration\n\nAt the most basic level, your entrypoints are configured in your `package.json`:\n\n- `bin` (see [npm docs](https://docs.npmjs.com/files/package.json#bin))\n- `main` and `module` (see [npm docs](https://docs.npmjs.com/files/package.json#main))\n\n#### Build hooks\n\n`siroc` makes available three hooks for customising your build, if you need it.\n\n1. `build:extend`\n1. `build:extendRollup`\n1. `build:done`\n\n### `siroc dev`\n\nIf you're working in a monorepo, it can be helpful to have accurate and up-to-date intellisense when importing from other libraries in a monorepo, without having to rebuild every time you make changes.\n\nRunning `siroc dev` will replace your package entrypoints with stubs that point to your source files. Your binaries will run your source files directly using `jiti`.\n\n### `siroc eslint`\n\nRather than configure `eslint`, you can run it directly using `siroc eslint`, with support for TypeScript (and prettier, if you have it installed within your package dev dependencies).\n\nIf you would like to extend or modify the siroc base config you can do so with the following `.eslintrc.js`\n\n```js\nmodule.exports = {\n extends: ['@siroc'],\n // Your rules/plugins here\n}\n```\n\n### `siroc jest`\n\nRather than configure `jest`, you can run it directly using `siroc jest`, with support for TypeScript test and source files. By default it will include any settings from a local `jest.config.js`.\n\nIf you would like to extend or modify the siroc base config (for example, to run jest directly with `yarn jest`) you can do so with the following `jest.config.js`\n\n```js\nmodule.exports = {\n preset: '@siroc/jest-preset',\n // Your customisations here\n}\n```\n\n### `siroc run`\n\nYou can run arbitrary shell commands or node scripts using the power of [the `jiti` runtime](https://github.com/nuxt-contrib/jiti).\n\nFor example:\n\n```bash\n# You can run a node script written in TypeScript\nyarn siroc run myfile.ts\n\n# You can run a command in all your workspaces\nyarn siroc run ls --workspaces\n```\n\n## Contributors\n\nContributions are very welcome.\n\n1. Clone this repo\n\n ```bash\n git clone git@github.com:nuxt-contrib/siroc.git\n ```\n\n2. Install dependencies and build project\n\n ```bash\n yarn\n\n # Stub modules for rapid development\n yarn siroc dev\n\n # Test (on changes)\n yarn siroc jest\n ```\n\n**Tip:** You can also run `yarn link` within a package directory to test the module locally with another project.\n\n## License\n\n[MIT License](./LICENCE) - Made with 💖\n","readmeFilename":"README.md"}