https://github.com/johanbook/generator-typescript-best-practices

Yeoman generator for scaffolding a typescript project
https://github.com/johanbook/generator-typescript-best-practices

generator typescript yeoman

Last synced: 2 days ago
JSON representation

Yeoman generator for scaffolding a typescript project

• Host: GitHub
• URL: https://github.com/johanbook/generator-typescript-best-practices
• Owner: johanbook
• Created: 2021-08-29T06:28:42.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-10T13:55:43.000Z (over 1 year ago)
• Last Synced: 2023-08-24T02:22:26.081Z (about 1 year ago)
• Topics: generator, typescript, yeoman
• Language: JavaScript
• Homepage:
• Size: 73.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# generator-typescript-best-practices

![](https://img.shields.io/npm/v/generator-typescript-best-practices)

**generator-typescript-best-practices** is a [Yeoman](http://yeoman.io/)

generator for creating a TypeScript project with strict linting. This includes

the following

- [commitlint](https://commitlint.js.org) to enforce

  [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)

- [husky](https://www.npmjs.com/package/husky) for handling Git hooks. The

  following hooks are installed:

  - pre-commit hook for formatting staged code and verifying that commit

    messages adheres to conventional commits

  - pre-push hook for running linting and verifying test coverage

- [Prettier](https://prettier.io/) for formatting

  - [import-sort](https://github.com/renke/import-sort) for sorting imports as

    part of formatting process

- [Eslint](https://eslint.org/) for linting

  - [eslint-plugin-sonarjs](https://github.com/SonarSource/eslint-plugin-sonarjs)

    for code analysis as part of linting

  - [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)

    for powerful linting rules

  - TypeScript parser for allowing Eslint to parse TypeScript

- [lint-staged](https://www.npmjs.com/package/lint-staged) for only linting

  staged files to avoid formatting whole project as part of pre-commit hook

- [Standard Version](https://www.npmjs.com/package/standard-version) for

  automated releases

- [TypeScript](https://www.typescriptlang.org/) if not already installed

## Scaffolding a project

Before using this generator, the NPM package must be installed on the local

machine. A global install can be accomplished using

```sh

npm i -g generator-typescript-best-practices

```

To scaffold an existing project, navigate to a TypeScript repository where Git

and NPM already have been initialized and run

```sh

npx yo typescript-best-practices

```

## Contributing

See the [contribution guide](./CONTRIBUTING.md).