|
| 1 | +# Contributing |
| 2 | + |
| 3 | +This repository is created by using [Turborepo](https://turbo.build/repo). To understand the repository structure better, please check its [documentation](https://turbo.build/repo/docs). |
| 4 | + |
| 5 | +## Local Development |
| 6 | + |
| 7 | +After cloning the repository, we need to install the dependencies. |
| 8 | + |
| 9 | +```bash |
| 10 | +npm install |
| 11 | +``` |
| 12 | + |
| 13 | +To start the demo Next.js app which uses the local version of `react-intersection-obverser-hook`, we can run `dev` script. |
| 14 | + |
| 15 | +```bash |
| 16 | +npm run dev |
| 17 | +``` |
| 18 | + |
| 19 | +After this, we can open `http://localhost:3000` in the browser to display the app. |
| 20 | + |
| 21 | +## Code Quality Checks |
| 22 | + |
| 23 | +We use automated checks by using [ESLint](https://eslint.org/), [Prettier](https://prettier.io/) and [TypeScript](https://www.typescriptlang.org/) to provide the highest quality code as it can be. |
| 24 | + |
| 25 | +All checks are run automatically before committing by using [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/lint-staged/lint-staged). |
| 26 | + |
| 27 | +The checks can be run manually by running the below command too. |
| 28 | + |
| 29 | +```bash |
| 30 | +npm run codequality:check |
| 31 | +``` |
| 32 | + |
| 33 | +And the same checks can be run also by enabling fixes for auto-fixable issues. |
| 34 | + |
| 35 | +```bash |
| 36 | +npm run codequality:fix |
| 37 | +``` |
| 38 | + |
| 39 | +`codequality` scripts run underlying ESLint (`lint`), Prettier (`format`) and TypeScript (`types`) scripts. To run these tools individually, we can also use the below scripts. |
| 40 | + |
| 41 | +```bash |
| 42 | +# ESLint checks |
| 43 | +npm run lint:check |
| 44 | +# ESLint fixes |
| 45 | +npm run lint:fix |
| 46 | + |
| 47 | +# Prettier checks |
| 48 | +npm run format:check |
| 49 | +# Prettier fixes |
| 50 | +npm run format:fix |
| 51 | + |
| 52 | +# TypeScript checks |
| 53 | +npm run types:check |
| 54 | +# There is no auto-fix script for TypeScript. |
| 55 | +``` |
| 56 | + |
| 57 | +## Updating Dependencies |
| 58 | + |
| 59 | +We use `npm-check-updates` package to automatically check if there are newer versions of our dependencies. |
| 60 | + |
| 61 | +To run it, we can use the below command. It starts an interactive CLI to check the dependencies of all the apps and packages, including the root dependencies. |
| 62 | + |
| 63 | +```bash |
| 64 | +npm run updates:check |
| 65 | +``` |
| 66 | + |
| 67 | +## Adding Contributors |
| 68 | +[all-contributors-cli](https://github.com/all-contributors/cli) is used for maintaining the contributors of this repository. |
| 69 | + |
| 70 | +To add a new contributor, we can run the below command and follow its instructions. |
| 71 | + |
| 72 | +```bash |
| 73 | +npm run contributors:add |
| 74 | +``` |
| 75 | + |
| 76 | +## Prepublish Checks |
| 77 | + |
| 78 | +To be sure everything is OK with the latest changes, we can use [publint](https://publint.dev/) and [Are the Types Wrong](https://github.com/arethetypeswrong/arethetypeswrong.github.io). |
| 79 | + |
| 80 | +Firstly, we need to build the bundle with the latest changes. |
| 81 | + |
| 82 | +```bash |
| 83 | +npm run build:bundle |
| 84 | +``` |
| 85 | + |
| 86 | +This command will create (or update) the `packages/react-intersection-observer-hook/dist` folder, which will be used by the clients of this package. |
| 87 | + |
| 88 | +To be sure the output is OK for ESM and CJS clients, we can run the below commands and check their outputs. |
| 89 | + |
| 90 | +```bash |
| 91 | +# For `publint` |
| 92 | +npm run publint:check -w react-intersection-observer-hook |
| 93 | + |
| 94 | +# For `Are the Types Wrong` |
| 95 | +npm run attw:check -w react-intersection-observer-hook |
| 96 | +``` |
| 97 | + |
| 98 | +To see the content of the package which can be uploaded to [npm](https://www.npmjs.com/) can be seen by using the below command. It will create a tarball from `react-intersection-observer-hook` package. |
| 99 | + |
| 100 | +```bash |
| 101 | +npm pack -w react-intersection-observer-hook |
| 102 | +``` |
| 103 | + |
| 104 | +Or the below command can be used to only check the tarball contents without creating it. |
| 105 | + |
| 106 | +```bash |
| 107 | +npm pack --dry-run -w react-intersection-observer-hook |
| 108 | +``` |
| 109 | + |
| 110 | +Lastly, we can run the below command to auto correct common errors in `package.json` of the package to be published. `npm publish` command already does these auto-fixes too. |
| 111 | + |
| 112 | +```bash |
| 113 | +npm pkg fix -w react-intersection-observer-hook |
| 114 | +``` |
| 115 | + |
| 116 | +## Publish |
| 117 | +Firstly, we need to bump the package version which can be done by using the below commands. |
| 118 | + |
| 119 | +```bash |
| 120 | +npm version patch -w react-intersection-observer-hook |
| 121 | +# Bumps the patch number like 0.0.0 -> 0.0.1 |
| 122 | + |
| 123 | +npm version minor -w react-intersection-observer-hook |
| 124 | +# Bumps the patch number like 0.0.x -> 0.1.0 |
| 125 | + |
| 126 | +npm version major -w react-intersection-observer-hook |
| 127 | +# Bumps the patch number like 0.x.y -> 1.0.0 |
| 128 | +``` |
| 129 | + |
| 130 | +And we can publish the new version now 🚀 |
| 131 | + |
| 132 | +```bash |
| 133 | +npm publish -w react-intersection-observer-hook |
| 134 | +``` |
0 commit comments