https://github.com/growflowteam/javascript
Shareable configuration to apply consistent syntax and styling rules across GrowFlow TypeScript projects
https://github.com/growflowteam/javascript
eslint-config prettier-config tsconfig
Last synced: 10 days ago
JSON representation
Shareable configuration to apply consistent syntax and styling rules across GrowFlow TypeScript projects
- Host: GitHub
- URL: https://github.com/growflowteam/javascript
- Owner: GrowflowTeam
- License: mit
- Created: 2021-01-08T18:09:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T16:06:12.000Z (over 1 year ago)
- Last Synced: 2025-01-16T08:11:41.265Z (9 months ago)
- Topics: eslint-config, prettier-config, tsconfig
- Language: JavaScript
- Homepage:
- Size: 693 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GrowFlow Javascript Style Guide
> Shareable configuration to apply consistent syntax and styling rules across GrowFlow JavaScript/TypeScript projects.
## Usage
Checkout the instructions for each individual package:
* [Browserslist config](./packages/browserslist/README.md)
* [ESLint config](./packages/eslint/README.md)
* [Prettier config](./packages/prettier/README.md)
* [Jest config](./packages/jest/README.md)
## Developing
Clone this repo and run `yarn` from the repository's root to install dependencies.
### Creating a new package
1. First create a new folder within the `packages` directory.
2. Copy one of the existing package's `package.json` to your new folder and tweak the values.
3. Update the package list in `deploy.yml` and the `workspaces` list in the root `package.json`.
### Deploying to npm
1. Ensure you **update the `version` field** in the `package.json` files of the packages you want to publish.
2. [Create a release in GitHub](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release) describing the changes pointing to the commit with your changes (usually the `HEAD` of `main`). Follow semver for the tag which should be named in the format `{package}-v{major}.{minor}.{patch}`. e.g. `eslint-v4.20.0`.
3. A GitHub action looks for packages with versions that don't match what's published on npm and publishes the changed packages.