Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/untile/js-configs
Untile configs and conventions
https://github.com/untile/js-configs
browserlist commitlint cypress es6 eslint javascript jest nextjs node nodejs prettier react react-native styled-components stylelint typescript vitest
Last synced: 28 days ago
JSON representation
Untile configs and conventions
- Host: GitHub
- URL: https://github.com/untile/js-configs
- Owner: untile
- License: mit
- Created: 2022-07-18T15:37:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T08:55:32.000Z (about 2 months ago)
- Last Synced: 2024-12-09T00:48:52.492Z (about 1 month ago)
- Topics: browserlist, commitlint, cypress, es6, eslint, javascript, jest, nextjs, node, nodejs, prettier, react, react-native, styled-components, stylelint, typescript, vitest
- Language: JavaScript
- Homepage: https://untile.pt
- Size: 719 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A common configs and conventions for Untile projects.
## Setup
This project uses [yarn workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/) to manage multiple packages.
### Install dependencies
```sh
yarn
```
### Run lint
```sh
yarn lint
```
### Run full test suite
```sh
yarn test
```
## Adding new packages
To ensure that every part of the monorepo infrastructure works as intended, every package must be located within the `./packages/` folder.
### Release setup
After creating a package, add a release script to the `./packages//package.json` file, and another one to the main `./package.json` file with:
```json
"release:": "yarn workspace @untile/ release",
```
### Changelog setup
When creating new packages, keep in mind that the **auto labeler** must have the new package added in `.github/labeler`, so that it can label its pull requests accordingly and they are included in the correct `CHANGELOG.md`. To add new packages to auto labeler run:
```sh
sh bin/auto-labeler.sh
```
## Release & Publish
Make sure that you have configured `GITHUB_TOKEN` in your globals.
This will also publish your packages that have changes to [NPM](https://www.npmjs.com/~untile).
```sh
yarn release:[] [ | major | minor | patch]
git push origin master && git push --tags
```