https://github.com/atom-community/prettier-config-atomic
The Prettier configuration used in atom-ide-community
https://github.com/atom-community/prettier-config-atomic
hacktoberfest prettier prettier-config prettier-preset
Last synced: 6 months ago
JSON representation
The Prettier configuration used in atom-ide-community
- Host: GitHub
- URL: https://github.com/atom-community/prettier-config-atomic
- Owner: atom-community
- License: mit
- Created: 2021-03-21T07:38:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T02:09:12.000Z (7 months ago)
- Last Synced: 2025-03-25T15:32:55.301Z (6 months ago)
- Topics: hacktoberfest, prettier, prettier-config, prettier-preset
- Language: TypeScript
- Homepage:
- Size: 311 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# prettier-config-atomic
The Prettier configuration used in atom-community.
This configuration supports all the formats including `typescript`, `javascript`, `json`, `yaml`, and `markdown`.
## Installation
```
npm install --save-dev prettier-config-atomic
```
This package also needs `prettier`.
Either add the following to your `.npmrc` if using `pnpm` to hoist the prettier bundled with the config
```
public-hoist-pattern[]=*
```
Or install `prettier` yourself in your `devDependencies`.
If using `npm`, the prettier dependency is hoisted automatically.
## Usage
Add the following to your `package.json`
```json
"prettier": "prettier-config-atomic",
"scripts": {
"format": "prettier --write .",
"test.format": "prettier . --check"
}
```
and run `npm run format` to format the files. You can also use `npm run test.format` in the CI to test formatting of the project.
To ignore some files from formatting, create a `.prettierignore` file and add the files to the list. This is usually the same as `gitignore`.
```
node_modules
pnpm-lock.yaml
package-lock.json
CHANGELOG.md
dist
```
Notice that the built folders like `dist` are in the above list.
### Modifying the config
Instead of adding the `prettier` entry to `package.json`, create a `prettier.config.js` file at the root of the project with the following content:
```js
module.exports = {
...require("prettier-config-atomic"),
// add the modifications here:
// an example:
// semi: true,
}
```
### GitHub Action Lint Job:
```yaml
Lint:
if: "!contains(github.event.head_commit.message, '[skip ci]')"
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Commit lint ✨
uses: wagoid/commitlint-github-action@v2
- name: Install dependencies
run: npm install
- name: Format ✨
run: npm run test.format
- name: Lint ✨
run: npm run test.lint
```