# @inpyjamas/scripts

> common config and scripts

Latest version **1.0.0** (published 2022-07-04) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @inpyjamas/scripts
pnpm add @inpyjamas/scripts
yarn add @inpyjamas/scripts
bun add @inpyjamas/scripts
```

Provides the command `inpyjamas-scripts`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-07-04 |
| First published | 2020-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 23 |
| Unpacked size | 50.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Fabian Morón Zirfas |
| Maintainers | fabian.moron.zirfas |

## Links

- npm: https://www.npmjs.com/package/@inpyjamas/scripts
- Repository: https://github.com/inpyjamas/scripts
- Homepage: https://github.com/inpyjamas/scripts#readme
- Issues: https://github.com/inpyjamas/scripts/issues
- npm.io page: https://npm.io/package/@inpyjamas/scripts

## Dependencies (23)

- [jest](https://npm.io/package/jest.md) 28.1.2
- [husky](https://npm.io/package/husky.md) 8.0.1
- [is-ci](https://npm.io/package/is-ci.md) 3.0.1
- [eslint](https://npm.io/package/eslint.md) 8.19.0
- [rimraf](https://npm.io/package/rimraf.md) 3.0.2
- [ts-jest](https://npm.io/package/ts-jest.md) 28.0.5
- [ts-node](https://npm.io/package/ts-node.md) 10.8.2
- [prettier](https://npm.io/package/prettier.md) 2.7.1
- [cross-env](https://npm.io/package/cross-env.md) 7.0.3
- [typescript](https://npm.io/package/typescript.md) 4.7.4
- [@types/jest](https://npm.io/package/@types/jest.md) 28.1.4
- [cross-spawn](https://npm.io/package/cross-spawn.md) 7.0.3
- [lint-staged](https://npm.io/package/lint-staged.md) 13.0.3
- [ts-node-dev](https://npm.io/package/ts-node-dev.md) 2.0.0
- [@types/is-ci](https://npm.io/package/@types/is-ci.md) 3.0.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) 4.6.2
- [@types/cross-spawn](https://npm.io/package/@types/cross-spawn.md) 6.0.2
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) 26.5.3
- [@types/lodash.merge](https://npm.io/package/@types/lodash.merge.md) 4.6.7
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) 8.5.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) 4.2.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) 5.30.4
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) 5.30.4

## Recent versions

- 1.0.0 (latest) — 2022-07-04
- 0.1.12-alpha — 2021-04-27
- 0.1.11-alpha — 2021-03-03
- 0.1.10-alpha — 2021-02-24
- 0.1.9-alpha — 2020-10-27
- 0.1.8-alpha — 2020-09-28
- 0.1.7-alpha — 2020-08-07
- 0.1.6-alpha — 2020-07-27
- 0.1.5-alpha — 2020-06-22
- 0.1.4-alpha — 2020-06-22
- 0.1.2-alpha — 2020-06-22
- 0.1.1-alpha — 2020-06-22
- 0.1.0-alpha — 2020-06-03

## README

# @inpyjamas/scripts

_⚠️ This is totally Work In Progress. Please ignore ⚠️_ An opinionated toolkit for setting up projects. Inspired (and plugged a lot) from [react-scripts][react-scripts] and [kcd-scripts][kcd-scripts]

## Todos/Ideas

- [ ] How to include scripts? `start` (`node dist/index.js`), `dev`, `build` (`tsc -p .` set `NODE_ENV`), ~~`test` (`jest` should detect ci and generate coverage, set `BABEL_ENV` and `NODE_ENV`)~~
- [ ] Document the existing configs
- [ ] How to update `package.json` with the right scripts? [mrm][mrm]? roll your own?
- [ ] Add plop?
- [ ] Add modules in the root so we don't have to link to `@inpyjamas/scripts/dist/config/eslint/typescript` just `@inpyjamas/scripts/eslint-typescript` or one module that exports all the configs `{eslint-ts:{…}}`
- [ ] ~~Scaffold configs for, prettier, lint-staged, jest, husky, .eslintignore or~~ This should be done by yo generator!

## Installation

Add it to an existing project

```bash
npm install @inpyjamas/scripts --save-dev --save-exact
```

Init a new project._⚠️ Not yet implemented ⚠️_
Most of the templates use `@inpyjamas/scripts` in one way or another

```bash
npm install --global yo
npm install --global @inpyjamas/generator-defaults
yo @inpyjamas/defaults
```

## Usage

## Included configs

## Extending configs

You can import any config and extend it.

```js
// this is jest.config.js
const config = require("@inpyjamas/scripts/jest");
config.testPathIgnorePatterns.push("src/scripts/test.ts");
config.collectCoverageFrom.push("!src/scripts/test.ts");
module.exports = config;
```

The package contains a merge utility for merging more complex scenarios.

```js
// this is jest.config.js
const config = require("@inpyjamas/scripts/jest");
const { merge } = require("@inpyjamas/scripts/utilities");

const localConfig = {
  testEnvironment: "jsdom",
  coverageThreshold: {
    global: {
      branches: 75,
      functions: 75,
      lines: 75,
      statements: 75,
    },
  },
};
module.exports = merge(config, localConfig);
```

## Release

- `npm version v0.1.x-alpha`
- git push --tags
- gh release create

---

[kcd-scripts]: https://github.com/kentcdodds/kcd-scripts
[react-scripts]: https://github.com/facebook/create-react-app
[mrm]: https://github.com/sapegin/mrm

---
_Source: https://npm.io/package/@inpyjamas/scripts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._