\n \n Daniel Bannert's open source work is supported by the community on GitHub Sponsors\n \n
\n
\n\n---\n\nSimplify your project setup with our comprehensive collection of preconfigured configuration files.\nDesigned for effortless integration, these ready-to-use files can be seamlessly imported into your projects.\nThese functions streamline the utilization of [lint-staged][lint-staged] / [nano-staged][nano-staged] alongside popular tools such as [ESLint](https://eslint.org), [Prettier](https://prettier.io), [StyleLint](https://stylelint.io) and [SecretLint](https://github.com/secretlint/secretlint).\n\nSay goodbye to complex configurations and enjoy a smoother development experience with our all-inclusive package.\n\n## Purpose\n\n- Enhance your development workflow with hassle-free and readily shareable lint-staged / nano-staged configuration files.\n- These files empower developers to maintain a uniform coding style and detect prevalent errors even before they are added to the source control system.\n- Additionally, our inclusive helper module offers convenient utility functions that seamlessly integrate lint-staged with popular linting and formatting tools.\n\n## Install\n\n```sh\nnpm install @anolilab/lint-staged-config\n```\n\n```sh\nyarn add @anolilab/lint-staged-config\n```\n\n```sh\npnpm add @anolilab/lint-staged-config\n```\n\n## Usage\n\nIf you don’t have a `.lintstagedrc.js` or `.nano-staged.js`, we can create the file for you after installing `@anolilab/lint-staged-config`, call `pnpm lint-stage-config:install`.\n\nIf you already have a `.lintstagedrc.js` or `.nano-staged.js`, then you can extend the `.lintstagedrc.js` or `.nano-staged.js`, with `@anolilab/lint-staged-config`.\n\n> Note: If the script detects an existing `.lintstagedrc.js` or `.nano-staged.js` file, it will not overwrite it.\n\nThe content of the `.lintstagedrc.js` or `.nano-staged.js` should look :\n\n```js\n// or\n\nimport { defineConfig } from \"@anolilab/lint-staged-config\";\n\nconst { defineConfig } = require(\"@anolilab/lint-staged-config\");\n\nmodule.exports = defineConfig();\n\nexport default defineConfig();\n```\n\n### Config\n\nYou can configure `@anolilab/lint-staged-config` options inside the `defineConfig` function.\n\n```js\n// or\n\nimport { defineConfig } from \"@anolilab/lint-staged-config\";\n\nconst { defineConfig } = require(\"@anolilab/lint-staged-config\");\n\nmodule.exports = defineConfig({\n // Add your configuration here\n});\n\nexport default defineConfig({\n // Add your configuration here\n});\n```\n\n## Configuration\n\nThe default configuration, automatically adds the following linting and formatting tools, if the needed dependencies are installed.\n\n- [ESLint](https://eslint.org)\n- [Prettier](https://prettier.io)\n- [StyleLint](https://stylelint.io)\n- [SecretLint](https://github.com/secretlint/secretlint)\n- [CommitLint](https://commitlint.js.org)\n- [Vitest](https://vitest.dev) or [Jest](https://jestjs.io) or [AVA](https://github.com/avajs/ava)\n- [TypeScript](https://www.typescriptlang.org)\n\nAll this tools configuration are exported at `@anolilab/lint-staged-config/group/...` and\ncan be used to extend your configuration, without including the auto config.\n\n## Husky\n\nIf you want to use [husky](https://github.com/typicode/husky) to run the lint-staged script, you can use the following configuration.\n\nAdding the following script to your root `package.json` file makes it easier to run the husky command:\n\n```bash\npnpm pkg set scripts.prepare=\"is-ci || husky install || exit 0\"\n```\n\nThis script will install husky only if it's not running in a CI environment.\n\nAfter that you can find a `.husky` folder in your root directory, with a `pre-commit` (if not please create it) file.\n\nThe file content can look :\n\n```bash\n#!/bin/sh\n\n. \"$(dirname \"$0\")/_/husky.sh\"\n\n# The hook should exit with non-zero status after issuing\n# an appropriate message if it wants to stop the commit.\n\necho --------------------------------------------\necho Starting Git hook: pre-commit\n\n./node_modules/.bin/lint-staged --verbose --concurrent false\n\necho Finished Git hook: pre-commit\necho --------------------------------------------\n```\n\nOr with `nano-staged`:\n\n```bash\n#!/bin/sh\n\n. \"$(dirname \"$0\")/_/husky.sh\"\n\n# The hook should exit with non-zero status after issuing\n# an appropriate message if it wants to stop the commit.\n\necho --------------------------------------------\necho Starting Git hook: pre-commit\n\n./node_modules/.bin/nano-staged\n\necho Finished Git hook: pre-commit\necho --------------------------------------------\n```\n\nOur package includes a `lint-stage-config:install` command to add the `pre-commit`, `common.sh`, `prepare-commit-msg hooks to your `.husky` folder.\n\nIf `commitzen` is installed, the `prepare-commit-msg` hook with predefined content will be added to your `.husky` folder.\n\n## Related\n\n## Supported Node.js Versions\n\nLibraries in this ecosystem make the best effort to track [Node.js’ release schedule](https://github.com/nodejs/release#release-schedule).\n\nHere’s [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).\n\n## Contributing\n\nIf you would like to help take a look at the [list of issues](https://github.com/anolilab/javascript-style-guide/issues) and check our [Contributing](.github/CONTRIBUTING.md) guidelines.\n\n> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.\n\n## Credits\n\n- [Daniel Bannert](https://github.com/prisis)\n\n- [All Contributors](https://github.com/anolilab/javascript-style-guide/graphs/contributors)\n\n## Made with ❤️ at Anolilab\n\nThis is an open source project and will always remain free to use. If you think it’s cool, please star it 🌟. [Anolilab](https://anolilab.com/open-source) is a Development and AI Studio. Contact at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or want to say hi!\n\n## License\n\nThe anolilab lint-staged-config is open-sourced software licensed under the [MIT][license-url]\n\n\n\n[license-badge]: https://img.shields.io/npm/l/@anolilab/lint-staged-config?style=for-the-badge\n[license]: https://github.com/anolilab/javascript-style-guide/blob/main/LICENSE\n[npm-downloads-badge]: https://img.shields.io/npm/dm/@anolilab/lint-staged-config?style=for-the-badge\n[npm-downloads]: https://www.npmjs.com/package/@anolilab/lint-staged-config\n[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge\n[prs-welcome]: https://github.com/anolilab/javascript-style-guide/blob/main/.github/CONTRIBUTING.md\n[chat-badge]: https://img.shields.io/discord/902465130518949899.svg?style=for-the-badge\n[chat]: https://discord.com/invite/4VuvwWGaaB\n[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript\n[typescript-url]: https://www.typescriptlang.org/\n[license-url]: https://opensource.org/licenses/MIT\n[lint-staged]: https://github.com/lint-staged/lint-staged\n[nano-staged]: https://github.com/usmanyunusov/nano-staged\n","readmeFilename":""}
![\"lint-staged-config\"](\"__assets__/package-og.svg\")
\n\n