@twostoryrobot/prettier - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

prettier.config.js

package.json

		{
		"name": "@twostoryrobot/prettier",
		"version": "1.0.0",
		"version": "2.0.0",
		"description": "prettier configuration for Two Story Robot",
		"main": "index.js",
		"scripts": {
		"postinstall": "ln -fs $(pwd)/prettierrc $(pwd)/../../../.prettierrc"
		},
		"main": "prettier.config.js",
		"repository": {
		@@ -10,0 +7,0 @@ "type": "git",

README.md

		@@ -0,17 +1,32 @@
		[![npm (scoped)](https://img.shields.io/npm/v/@twostoryrobot/prettier.svg)](https://www.npmjs.com/package/@twostoryrobot/prettier)


		# 2SR prettier

		Get pretty code with prettier the way Two Story Robot likes it.

		## Usage

		Installing the package will make a symlink in the root of your project to the
		prettier config in this repo. It is recommended to add `.prettierrc` to your
		`.gitignore` so you don't accidentally commit the symlink.

		```bash
		npm install @twostoryrobot/prettier
		npm install --save-dev @twostoryrobot/prettier
		```

		Then you can source the config from your own `prettier.config.js`.

		```js
		module.exports = require('@twostoryrobot/prettier')
		```

		Or if you want to override the default at all (Note: please consider making a PR
		if you think the override will be useful for other projects).

		```js
		const prettierConfig = require('@twostoryrobot/prettier')
		module.exports = Object.assign({}, prettierConfig, { semi: true })
		```

		Make sure to install the peer dependencies

		```bash
		npm install prettier
		npm install --save-dev prettier
		```
		@@ -36,5 +51,8 @@
		```json
		"scripts": {
		"precommit": "prettier --write '*/.js'"
		"husky": {
		"hooks": {
		"pre-commit": "prettier --list-different '*/.js'"
		}
		}
		}
		```

prettierrc

New alerts