2023-12-01 22:52:24 +00:00
|
|
|
# NodeJS Flake Template
|
|
|
|
|
|
|
|
|
|
This is a template for constructing a working environment for
|
|
|
|
|
[Node.js](https://nodejs.org/en) development (version v18.18.2) with the [npm](https://www.npmjs.com/)
|
|
|
|
|
(version 9.8.1) packaging tool. [direnv](https://direnv.net/) can be used to
|
|
|
|
|
launch a dev shell upon entering this directory (refer to `.envrc`). Otherwise
|
|
|
|
|
run via:
|
|
|
|
|
```bash
|
|
|
|
|
$ nix develop
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-13 22:49:55 +00:00
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
If you make changes to the `package-lock.json` file, you'll need to update the
|
|
|
|
|
`npmDepsHash` value in `flake.nix`. The easiest way to discover this value is
|
|
|
|
|
by running the following:
|
|
|
|
|
```bash
|
|
|
|
|
$ prefetch-npm-deps package-lock.json
|
|
|
|
|
```
|
|
|
|
|
Alternatively, you can set the value of `npmDepsHash` to `lib.fakeHash` and run:
|
|
|
|
|
```bash
|
|
|
|
|
$ nix build
|
|
|
|
|
```
|
2024-01-30 18:13:39 +00:00
|
|
|
Nix will complain with the hash value it actually expected.
|
2023-12-13 22:49:55 +00:00
|
|
|
|
2023-12-01 22:52:24 +00:00
|
|
|
## Language Server
|
|
|
|
|
|
|
|
|
|
The [typescript-language-server](https://github.com/typescript-language-server/typescript-language-server)
|
|
|
|
|
(version 4.1.2) is included in this flake.
|
|
|
|
|
|
|
|
|
|
## Formatting
|
|
|
|
|
|
|
|
|
|
Formatting depends on [prettier](https://prettier.io/) (version 3.1.0). A
|
|
|
|
|
`pre-commit` hook is included in `.githooks` that can be used to format all
|
|
|
|
|
`*.jsx?` and `*.tsx?` files prior to commit. Install via:
|
|
|
|
|
```bash
|
|
|
|
|
$ git config --local core.hooksPath .githooks/
|
|
|
|
|
```
|
|
|
|
|
If running [direnv](https://direnv.net/), this hook is installed automatically
|
|
|
|
|
when entering the directory.
|
|
|
|
|
|
