https://github.com/simongolms/prettier-config

DO NOT USE: Only for testing and gain knowledge for myself. Will be deleted in some days.
https://github.com/simongolms/prettier-config

Last synced: 5 days ago
JSON representation

DO NOT USE: Only for testing and gain knowledge for myself. Will be deleted in some days.

• Host: GitHub
• URL: https://github.com/simongolms/prettier-config
• Owner: SimonGolms
• License: mit
• Created: 2022-11-28T14:26:13.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-29T12:38:16.000Z (almost 2 years ago)
• Last Synced: 2024-08-08T20:54:46.610Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 97.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prettier-config

Prettier config used at SimonGolms

![npm version](https://img.shields.io/npm/v/@golms/prettier-config?label=npm%20Version&logo=npm)

[![License: Apache-2.0](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/simongolms/prettier-config/blob/master/LICENSE)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/simongolms/prettier-config/graphs/commit-activity)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg?logo=conventional-commits)](https://conventionalcommits.org)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-494949?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

## Usage

Install the package using `npm`

```sh

npm install --save-dev --save-exact @golms/prettier-config

```

Create a `.prettierrc.js` file in your projects root directory and export your desired modifications.

```js

module.exports = {

  ...require("@golms/prettier-config"),

  // printWidth: 140, // to overwrite the property

};

```

[Check out the `prettier` documentation for more info on sharing configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations).

## Local Development

### Install Dependencies

```sh

npm install

```

### Test

```sh

npm test

```

### Repair

This command may be useful when obscure errors or issues are encountered. It removes and recreates dependencies of your project.

```sh

npm run repair

```

### Release

Fully automated version management and package publishing via [semantic-release](https://github.com/semantic-release). It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.

#### Automatic Release (GitHub Action) [Recommended]

Make sure that the secrets `GITHUB_TOKEN` and `NPM_TOKEN` are available in GitHub repository.

```sh

npm run release:ci

```

#### Manual Release

Make sure that the environment variables `GITHUB_TOKEN` and `NPM_TOKEN` are set or declared in `.env` and a productive build was previously created via `npm run build`.

```sh

npm run release

```

## Show your support

Give a ⭐️ if this project helped you!

## License

Copyright © 2022 [Simon Golms](https://github.com/simongolms).


This project is [MIT](https://github.com/simongolms/prettier-config/blob/master/LICENSE) licensed.

## Resources

- https://prettier.io/