\n\n \n\n## β¨ Features\n\n- π¦ One package to encapsulate most tooling dependencies\n- βοΈ Common (extensible) configurations to eliminate boilerplate\n- π Conventions that help enforce consistency\n- π₯½ Best practices to help avoid π¦Άπ»π«\n\n## Contents\n\n\n\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [Overriding Config](#overriding-config)\n - [ESLint](#eslint)\n - [Prettier](#prettier)\n - [Jest](#jest)\n - [Semantic Release](#semantic-release)\n - [Depcheck](#depcheck)\n - [Lint Staged](#lint-staged)\n - [Source Control Hooks](#source-control-hooks)\n - [Husky Example](#husky-example)\n- [License](#license)\n- [Maintenance](#maintenance)\n\n\n\n## Installation\n\nThis module is distributed via [npm][npm-link] which is bundled with\n[node][node-link] and should be installed as one of your project's\n`devDependencies`:\n\n```\nyarn add -D @hover/javascript\n```\n\n## Usage\n\nThis is a CLI and exposes a bin called **`hover-scripts`**. You'll find all\navailable scripts in `src/scripts`.\n\nThis project actually dogfoods itself. If you look in the `package.json`, you'll\nfind scripts with `node src {scriptName}`. This serves as an example of some of\nthe things you can do with `hover-scripts`.\n\n### Overriding Config\n\nUnlike **[react-scripts][react-scripts-link]**, `hover-scripts` allows you to\nspecify your own configuration for things and have that plug directly into the\nway things work with `hover-scripts`. There are various ways that it works, but\nbasically if you want to have your own config for something, just add the\nconfiguration and `hover-scripts` will use that instead of it's own internal\nconfig. In addition, `hover-scripts` exposes its configuration so you can use it\nand override only the parts of the config you need to.\n\nThis can be a very helpful way to make editor integration work for tools like\nESLint which require project-based ESLint configuration to be present to work.\n\n> Note: `hover-scripts` intentionally does not merge things for you when you\n> start configuring things to make it less magical and more straightforward.\n> Extending can take place on your terms.\n\n#### ESLint\n\nSo, if we were to do this for ESLint, you could create an `.eslintrc.js` with\nthe contents of:\n\n```js\nmodule.exports = {\n extends: require.resolve('@hover/javascript/eslint'),\n // Include this when using TypeScript\n parserOptions: {\n project: ['./tsconfig.json'],\n },\n}\n```\n\n##### Strict Preset\n\n> β¨ The strict preset is recommended for new projects!\n\nA strict preset is also available that includes more agressive linting rules\nthat enforce the order and grouping of imports.\n\n```js\nmodule.exports = {\n extends: [\n require.resolve('@hover/javascript/eslint'),\n require.resolve('@hover/javascript/eslint/strict'),\n ],\n // Include this when using TypeScript\n parserOptions: {\n project: ['./tsconfig.json'],\n },\n}\n```\n\n##### React Preset\n\n> βΉοΈ The standard preset attempts to detect a React dependency and enable this\n> preset automatically so this is usually only necessary in edge cases where\n> React is not detected (such as a monorepo)\n\nA React preset is available that includes additional React-specific rules as\nwell as the **eslint-plugin-react-hooks** plugin.\n\n```js\nmodule.exports = {\n extends: require.resolve('@hover/javascript/eslint/react'),\n}\n```\n\n#### Prettier\n\nOr, for Prettier, a `.prettierrc.js` with:\n\n```js\nmodule.exports = require('@hover/javascript/prettier')\n```\n\n#### Jest\n\nOr, for Jest in `jest.config.js`:\n\n> β οΈ Starting with\n> [**7.0**](https://github.com/hoverinc/hover-javascript/releases/tag/v7.0.0),\n> the default Jest `transform` is\n> [**@swc-node/jest**](https://github.com/swc-project/swc-node/#swc-nodejest).\n> If you want to continue using\n> [**ts-jest**](https://kulshekhar.github.io/ts-jest/), simpy install `ts-jest`\n> in your project and it will automatically be used as the `transform` instead.\n\n```js\nconst config = require('@hover/javascript/jest')\n\nmodule.exports = {\n ...config,\n coverageThreshold: null,\n}\n```\n\n#### Semantic Release\n\n> π Set the `version` field in your `package.json` to\n> `0.0.0-semantically-released` to enable Semantic Release in the\n> `ci-after-success` script\n\nOr, for Semantic Release (used in `ci-after-success` script) in\n`release.config.js`:\n\n```js\nmodule.exports = {\n extends: require.resolve('@hover/javascript/release'),\n}\n```\n\n#### Depcheck\n\n> βΉοΈ The `hoverBabel` special requires NODE_PATH to be defined to resolve the\n> babel config file\n\nOr, for depcheck in `.depcheckrc.json'`:\n\n```json\n{\n \"specials\": [\n \"babel\",\n \"bin\",\n \"jest\",\n [\n \"hoverBabel\",\n {\n \"config\": \"babel.config.js\",\n \"env\": \"development\"\n }\n ]\n ],\n \"ignoreMatches\": [\"types/*\"]\n}\n```\n\n#### Lint Staged\n\nOr, for lint-staged (used in `pre-commit` script) in `lint-staged.config.js`:\n\n```js\nmodule.exports = {\n ...require.resolve('@hover/javascript/lint-staged'),\n '*.+(js|jsx|ts|tsx)': ['yarn some-custom-command'],\n}\n```\n\n##### Custom Test Command\n\nIf all you want to do is run a custom test command, you can pass `--testCommand`\nto `hover-scripts pre-commit`. The built-in lint-staged configuration will be\nused with your custom command.\n\n```json\n{\n \"name\": \"my-package\",\n \"husky\": {\n \"hooks\": {\n \"pre-commit\": \"hover-scripts pre-commit --testCommand 'yarn test:custom' --findRelatedTests\"\n }\n }\n}\n```\n\n### Source Control Hooks\n\nThis package includes a couple scripts designed to be run as part of your\nproject's source control workflow. The most common workflow is using\n[Husky](https://github.com/typicode/husky) to manage\n[Git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), but they\nshould work with other solutions as well.\n\n#### Husky Example\n\n> βΉοΈ See [Husky Documentation](https://typicode.github.io/husky/#/?id=usage) for\n> more information\n\n1. Install Husky\n\n ```bash\n yarn add -D husky\n ```\n\n2. Add `prepare` script\n\n ```bash\n npm set-script prepare \"husky install\"\n ```\n\n3. Create hooks\n\n i. π **.husky/pre-commit**\n\n ```bash\n yarn husky add .husky/pre-commit \"yarn hover-scripts pre-commit\"\n ```\n\n ii. π **.husky/commit-msg**\n\n ```bash\n yarn husky add .husky/commit-msg \"yarn hover-scripts commit-msg\"\n ```\n\n## License\n\nMIT\n\n## Maintenance\n\nThis project is actively maintained by engineers at\n[@hoverinc][hover-github-link] π.\n\n[hover-github-link]: https://github.com/hoverinc\n[node-link]: https://nodejs.org\n[npm-link]: https://www.npmjs.com/\n[react-scripts-link]:\n https://github.com/facebook/create-react-app/tree/master/packages/react-scripts\n[build-badge]:\n https://github.com/hoverinc/hover-javascript/actions/workflows/build.yml/badge.svg\n[build-link]:\n https://github.com/hoverinc/hover-javascript/actions/workflows/build.yml\n[conventional-commits-badge]:\n https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\n[conventional-commits-link]: https://conventionalcommits.org\n[coverage-link]: https://codecov.io/github/hoverinc/hover-javascript\n[coverage-badge]:\n https://img.shields.io/codecov/c/github/hoverinc/hover-javascript.svg\n[maintenance-badge]:\n https://img.shields.io/badge/maintenance-active-247ddc?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAcCAYAAACUJBTQAAAB1ElEQVRIibWWPUtdQRCGH0VNF/wCCVjYCxr/gZWdhYVgLQYbm/wACTYxxA8SSBDtbKwUbfQWkiJFAgkkmHBBY6U2CXaCGlDDG1buxePOnt17bsgD28zOzjtnZvbuRVKR1SFpVdKepEe1njOGnOWCz0q60B1lSa05/oVE2iTNSfqdCZ7lSyWB0NmkSJekeUmXJqzlayWZUJxckUUTJs23mFAjlhNjSdMHfAQ6g54hZUnDdXyN44ek7iKNH4w0PMaeX7pQ8Ox6HQkWww3Dw1hPWoAJ4BxoB4aNR5oB4APQ5vekUdITSceZDLcreyORrGPcfpEL0CBpVNJRwLmUSWLS7NbGpju8FXEteT2qR+jQ9aS3QK2XgUljjXPpRC6iLpYV4KmxRghNVy28Aqb+t4jjLbBhrAH+RcRxZSwBUiINxlIHKZE/xlIHTTlHBDwHjoDPwHtgF/gEnBnvFJVfzSrXkpYyfxKGvIu14F3ONXP1LOWmzEPjpuWl92j55XyQyDnEjRN5AbwD9gMOPkV7tAPMOJE3ZuuOFmOpjS3gGfCdQDl8fgGnGVtzwt8F7wdGqgKOvOmq4iarB3gMjAFlb78qug5MAwehIO4tKViJe4wDP4FSrgfwF/ntR8JxRSf3AAAAAElFTkSuQmCC\n[maintenance-link]: https://github.com/hoverinc/hover-javascript#maintenance\n[license-badge]: https://img.shields.io/npm/l/@hover/javascript.svg\n[license-link]: https://github.com/hoverinc/hover-javascript/blob/master/LICENSE\n[node-link]: https://nodejs.org/en/download/\n[node-badge]: https://img.shields.io/badge/node-v18.12.1-green\n[prettier-badge]:\n https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier\n[prettier-link]: https://prettierjs.org/en/download/\n[package-badge]: https://img.shields.io/npm/v/@hover/javascript.svg\n[package-link]: https://www.npmjs.com/package/@hover/javascript\n","readmeFilename":"README.md"}
![\"Hover](\"https://user-images.githubusercontent.com/288160/95674568-ed8d6080-0b65-11eb-88be-d119c88ee285.png\")
\n