# @fcsukltd/config > This library provides a number of shared configurations Latest version **1.1.1** (published 2024-10-22) · ISC license · 0 weekly downloads ## Install ```sh npm install @fcsukltd/config pnpm add @fcsukltd/config yarn add @fcsukltd/config bun add @fcsukltd/config ``` Provides the command `cryo`. ## Health **Score 25/100 (F)** — status: maintenance-mode. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.1 | | Published | 2024-10-22 | | First published | 2023-01-20 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Node | >=20.10 | | Dependencies | 42 | | Unpacked size | 20 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Cryoserver | | Maintainers | mark_stratmann_cryoserver, davidkelley87 | ## Links - npm: https://www.npmjs.com/package/@fcsukltd/config - Homepage: https://CryoserverAdmin@dev.azure.com/CryoserverAdmin/Software%20Development/_git/config-nodejs#readme - Issues: https://CryoserverAdmin@dev.azure.com/CryoserverAdmin/Software%20Development/_git/config-nodejs/issues - npm.io page: https://npm.io/package/@fcsukltd/config ## Dependencies (42) - [msw](https://npm.io/package/msw.md) ^2.0.11 - [jest](https://npm.io/package/jest.md) ^29.7.0 - [debug](https://npm.io/package/debug.md) ^4.3.4 - [husky](https://npm.io/package/husky.md) ^8.0.3 - [is-ci](https://npm.io/package/is-ci.md) ^3.0.1 - [dotenv](https://npm.io/package/dotenv.md) ^16.3.1 - [eslint](https://npm.io/package/eslint.md) ^8.56.0 - [ts-jest](https://npm.io/package/ts-jest.md) ^29.2.5 - [ts-node](https://npm.io/package/ts-node.md) ^10.9.2 - [prettier](https://npm.io/package/prettier.md) ^3.1.1 - [@swc/core](https://npm.io/package/@swc/core.md) ^1.7.39 - [@swc/jest](https://npm.io/package/@swc/jest.md) ^0.2.36 - [tsc-files](https://npm.io/package/tsc-files.md) ^1.1.4 - [jest-junit](https://npm.io/package/jest-junit.md) ^16.0.0 - [typescript](https://npm.io/package/typescript.md) 5.2.x - [@types/jest](https://npm.io/package/@types/jest.md) ^29.5.13 - [@types/node](https://npm.io/package/@types/node.md) ^22.7.8 - [jest-circus](https://npm.io/package/jest-circus.md) ^29.7.0 - [lint-staged](https://npm.io/package/lint-staged.md) ^15.2.0 - [@types/debug](https://npm.io/package/@types/debug.md) ^4.1.12 - [dotenv-expand](https://npm.io/package/dotenv-expand.md) ^10.0.0 - [tsconfig-paths](https://npm.io/package/tsconfig-paths.md) ^4.2.0 - [@commitlint/cli](https://npm.io/package/@commitlint/cli.md) ^18.4.3 - [@tsconfig/node16](https://npm.io/package/@tsconfig/node16.md) ^16.1.3 - [@tsconfig/node20](https://npm.io/package/@tsconfig/node20.md) ^20.1.4 - [semantic-release](https://npm.io/package/semantic-release.md) ^22.0.12 - [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.29.1 - [@semantic-release/git](https://npm.io/package/@semantic-release/git.md) ^10.0.1 - [@semantic-release/npm](https://npm.io/package/@semantic-release/npm.md) ^11.0.2 - [eslint-plugin-unicorn](https://npm.io/package/eslint-plugin-unicorn.md) ^50.0.1 - [@semantic-release/exec](https://npm.io/package/@semantic-release/exec.md) ^6.0.3 - [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^9.1.0 - [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^5.1.2 - [@semantic-release/github](https://npm.io/package/@semantic-release/github.md) ^9.2.6 - [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^6.16.0 - [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^15.0.0 - [@semantic-release/changelog](https://npm.io/package/@semantic-release/changelog.md) ^6.0.3 - [@commitlint/config-conventional](https://npm.io/package/@commitlint/config-conventional.md) ^18.4.3 - [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^6.16.0 - [@semantic-release/commit-analyzer](https://npm.io/package/@semantic-release/commit-analyzer.md) ^11.1.0 - [@google/semantic-release-replace-plugin](https://npm.io/package/@google/semantic-release-replace-plugin.md) ^1.1.0 - [@semantic-release/release-notes-generator](https://npm.io/package/@semantic-release/release-notes-generator.md) ^12.1.0 ## Recent versions - 1.1.1 (latest) — 2024-10-22 - 1.1.0 — 2024-10-22 - 1.0.10 — 2024-10-14 - 1.0.9 — 2024-07-09 - 1.0.8 — 2024-04-24 - 1.0.7 — 2024-02-28 - 1.0.6 — 2024-01-27 - 1.0.5 — 2024-01-26 - 1.0.4 — 2024-01-19 - 1.0.3 — 2024-01-19 - 1.0.2 — 2023-01-20 ## README # Shared Configuration This library provides a number of shared configurations. By default, nothing is installed. So if you wish to leverage shared configuration, add the snippets below to your own code: ### TypeScript Create `tsconfig.json` in the root of the project: ```json { "extends": "@fcsukltd/config/shared/tsconfig.json" } ``` ### Prettier Add the following to `package.json`: ```json { "prettier": "@fcsukltd/config/shared/prettier" } ``` ### ESLint Add the following to `package.json`: ```json { "scripts": { "lint": "cryo lint" }, "eslintConfig": { "extends": ["./node_modules/@fcsukltd/config/shared/eslint"] } } ``` ### Jest Add the following to `package.json`: > Note: This uses the SWC compiler for TypeScript ```json { "scripts": { "test": "cryo test" }, "jest": { "preset": "@fcsukltd/config/shared/jest" } } ``` ### Commitlint Add the following to `package.json`: ```json { "commitlint": { "extends": ["@fcsukltd/config/shared/commitlint"] } } ``` ### Semantic Release Add the following to `package.json`: ```json { "scripts": { "semantic-release": "cryo release" }, "release": { "extends": "@fcsukltd/config/shared/release" } } ``` ### Husky > Adding Husky to your project will also automatically enable `commitlint` and `lint-staged` libraries. > **You must have the [Jest] and [ESLint] configurations installed to use this** Add the following to `package.json`: ```json { "scripts": { "postinstall": "cryo husky install" } } ``` --- _Source: https://npm.io/package/@fcsukltd/config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._