https://github.com/re-quant/on-field-access
https://github.com/re-quant/on-field-access
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/re-quant/on-field-access
- Owner: Re-Quant
- License: mit
- Created: 2020-06-04T02:08:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T11:33:50.000Z (over 3 years ago)
- Last Synced: 2025-03-23T21:14:44.588Z (over 1 year ago)
- Language: JavaScript
- Size: 1.37 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Modern Wallaby JS Starter (TypeScript + Babel + Jest)
*Notice: If you have any propositions feel free to make an issue or create a pull request.*
## Features
* Wallaby JS works out of the box without any additional config
Notice: How to run in "Without Configuration" mode ([Official Wallaby JS Guide](https://wallabyjs.com/docs/intro/config.html#automatic-configuration))
* [ESLint](https://eslint.org) for linting JS & TS files ([TSLint is deprecated in 2019](https://github.com/palantir/tslint#tslint)). Basic rules configured.
* Very strict linting [config](/src/.eslintrc.js) ([airbnb](https://www.npmjs.com/package/eslint-config-airbnb-base) + [unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) + [some other plugins](/src/.eslintrc.js#L11))
* Unit Testing via [Jest](https://jestjs.io/) 24+
* Additional Jest matchers from [`jest-extended`](https://github.com/jest-community/jest-extended) configured
* [TypeScript](http://typescriptlang.org/) 3.7+ via [Babel](https://babeljs.io/docs/en/babel-preset-typescript)
* Yarn for packages installation and [`check-yarn`](/tools/check-yarn.js) utility to prevent packages installation via `npm`
* [`.nvmrc`](https://github.com/nvm-sh/nvm#nvmrc)
* Nothing platform related. This repository template can be used for NodeJS and for Browser development.
* Git hooks via [husky](https://www.npmjs.com/package/husky)
* [Utility](/tools/merge-with-repository-template.sh) to automatically pull updates from this template repository (`npm run tpl-repo:merge`)
## Ways to use
1. Clone as is
1. `git clone git@github.com:korniychuk/wallaby-ts-starter.git`
2. `cd wallaby-ts-starter`
3. `yarn`
2. Fork
0. Click **Fork** git button
1. `git clone git@github.com:YOUR_GIT_NAME/wallaby-ts-starter.git`
2. `cd wallaby-ts-starter`
3. `yarn`
3. Creating from template
0. Click **Fork** git button
1. Create new repository and specify template 
1. `git clone git@github.com:YOUR_GIT_NAME/NEW_REPOSITORY_NAME.git`
2. `cd NEW_REPOSITORY_NAME`
3. `yarn`
4. Using with already cloned repository as an additional origin for pulling updates
1. Automatically
```bash
npm run merge-tpl-repo
```
2. Manually
1. `git remote add template git@github.com:korniychuk/wallaby-ts-starter.git`
2. `git fetch template`
3. `git merge --allow-unrelated-histories template/master`
## How to
### How to use NodeJS version from the `.nvmrc`
1. Install NVM
2. Use `.nvmrc` file one of the next ways:
* Execute `nvm use` in the project root directory
* Install [NVM Loader](https://github.com/korniychuk/ankor-shell) and your .nvmrc will be loaded automatically when you open the terminal.
### How to make a build
`npm run build`
### How to run lint
* Just show problems `npm run lint`
* Fix problems if it is possible `npm run lint:fix`
### How to run tests
* All tests
`npm run test`
`npm run test:watch`
* Specific tests
`npm run test -- src/my.spec.ts`
`npm run test:watch -- src/my.spec.ts`
## Author
| [
Anton Korniychuk](https://korniychuk.pro) |
| :---: |