open-index/open-npm huggingface dataset:
npm package: @handy-common-utils/dev-dependencies
Description: This package contains dependencies that are common
Author: James Hu
Latest version: 1.2.0

# @handy-common-utils/dev-dependencies

This package contains dependencies that are common. It can be used to accelarate the scaffolding of Typescript projects.

## How to use (scenario of starting a new project from scratch)

### 0. Initialise NPM

This can be done through `npm init`.

### 1. Add as dependency

Just add it as a dev dependency:

```sh
npm install -D @handy-common-utils/dev-dependencies
```

### 2. Copy common configuration files

For new project, you may want to copy some common configuration files for scaffolding 
Here's the command line for copying those files:

```
cp ./node_modules/@handy-common-utils/dev-dependencies/{tsconfig.json,.nycrc.yml,.eslintrc.yml,.eslintignore,.mocharc.yml} .
```

Feel free to modify them for your needs.

### 3. Update `package.json`

If you are developing for a NPM package, these scripts can be added to your `package.json`:

```json
"scripts": {
  "pretest": "eslint . --ext .ts",
  "test": "nyc mocha -r ts-node/register test/**/*spec.ts",
  "prepare": "shx rm -rf dist && tsc",
  "preversion": "generate-api-docs-and-update-readme && git add README.md"
},
```

If you are developing a command line tool, these can be added to your `package.json`:

```json
"main": "dist/index.js",
"scripts": {
  "pretest": "eslint . --ext .ts",
  "test": "nyc mocha",
  "prepare": "shx rm -rf dist && tsc",
  "start": "npm run prepare && node dist/index.js"
},
```

If you have command line scripts, you may want to use this line for `prepare`:

```json
  "prepare": "shx rm -rf dist && tsc && shx chmod +x dist/bin/*.js",
```

### 4. Start coding!

By default your code goes to `src/` and your test cases go to `test/`, and compiled `.js` files go to `dist/`.
Feel free to change the configurations if this convention does not suit you.
npm package: @handy-common-utils/dev-dependencies-common
Description: This package contains dependencies that are common between @handy-common-utils/dev-dependencies-common-jest and @handy-common-utils/dev-dependencies-common-mocha
Author: James Hu
Latest version: 1.11.0

# @handy-common-utils/dev-dependencies-common

This package provides recommended dev dependencies.
It can be used to accelerate the scaffolding of TypeScript projects.

[![Version](https://img.shields.io/npm/v/@handy-common-utils/dev-dependencies-common.svg)](https://npmjs.org/package/@handy-common-utils/dev-dependencies-common)
[![Downloads/week](https://img.shields.io/npm/dw/@handy-common-utils/dev-dependencies-common.svg)](https://npmjs.org/package/@handy-common-utils/dev-dependencies-common)

Usually, you don't use this package directly, you use one of these instead:

- [@handy-common-utils/dev-dependencies-mocha](https://www.npmjs.com/package/@handy-common-utils/dev-dependencies-mocha) - Dev dependencies with `Mocha`, `Chai`, and `Istanbul`/`nyc` as the testing framework.
- [@handy-common-utils/dev-dependencies-jest](https://www.npmjs.com/package/@handy-common-utils/dev-dependencies-jest) - Dev dependencies with `Jest` as the testing framework.