This repository has been archived by the owner on Sep 21, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
[API-2267] Prettier config #1
Open
danschultz
wants to merge
2
commits into
main
Choose a base branch
from
prettier-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @vertexvis/platform |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Main | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: "Checkout changes" | ||
uses: actions/checkout@v2 | ||
- name: Setup NodeJS | ||
uses: actions/setup-node@v1 | ||
- name: "Install" | ||
run: "yarn install" | ||
- uses: JS-DevTools/npm-publish@v1 | ||
with: | ||
token: "${{ secrets.NPMJS_ACCESS_TOKEN }}" | ||
access: "public" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
module.exports = { | ||
trailingComma: "es5", | ||
tabWidth: 2, | ||
semi: true, | ||
singleQuote: false, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,41 @@ | ||
# prettier-config | ||
Vertex's shared config for Prettier. | ||
# @vertexvis/prettier-config | ||
|
||
Vertex's shared Prettier config. | ||
|
||
## Usage | ||
|
||
This is based on [Shared | ||
Configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations) | ||
in Prettier's documentation. | ||
|
||
1. Remove any existing `.prettierrc` files. | ||
2. Install the config. | ||
``` | ||
yarn add --dev @vertexvis/prettier-config | ||
|
||
# or | ||
|
||
npm install -D @vertexvis/prettier-config | ||
``` | ||
3. Update your `package.json` to reference the shared config. | ||
``` | ||
"prettier": "@vertexvis/prettier-config", | ||
``` | ||
|
||
## Overrides | ||
|
||
If you'd like to override any of the default settings, add a `.prettierrc.js` | ||
file in your project with any settings that you'd like to change: | ||
|
||
```js | ||
module.exports = { | ||
...require("@vertexvis/prettier-config"), | ||
semi: false, | ||
}; | ||
``` | ||
|
||
## Publishing to NPM | ||
|
||
To publish a release to NPM, run `yarn version` to update the major or minor | ||
version. Commit your changes and open a PR. Once the PR is merged, the new | ||
version will be published to NPM. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"name": "@vertexvis/prettier-config", | ||
"version": "1.0.0", | ||
"description": "Vertex's shared Prettier config.", | ||
"main": ".prettierrc.js", | ||
"repository": "[email protected]:Vertexvis/prettier-config.git", | ||
"author": "Dan Schultz <[email protected]>", | ||
"bugs": { | ||
"url": "https://github.com/vertexvis/prettier-config/issues" | ||
}, | ||
"homepage": "https://github.com/vertexvis/prettier-config#readme", | ||
"license": "MIT" | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For you @therockstorm :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
These are all just the default values now so is this repo needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then we can just delete
.prettierrc.json
files and call it a day!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, I haven't taken a look at the defaults in awhile.. settings like
trailingComma
used to default tonone
, which I always changed toes5
. I'll archive this project for now, so we can resurrect it if we disagree with something in Prettier.