Skip to content

Commit

Permalink
build: run prettier on everything (#962)
Browse files Browse the repository at this point in the history
* build: run prettier on everything

* build: use prettier when any eligible file has changed

* docs: fill list to protect against prettier garbling empty items

* build: ignore changelog files

* docs: avoid garbling example values

* docs: avoid garbling example values

* chore: add new reference

Co-Authored-By: Armano <armano2@users.noreply.github.com>

* style: apply autoformatting

Co-authored-by: Armano <armano2@users.noreply.github.com>
  • Loading branch information
marionebl and armano2 committed Feb 6, 2020
1 parent b5ba369 commit dc77563
Show file tree
Hide file tree
Showing 83 changed files with 1,473 additions and 1,829 deletions.
22 changes: 11 additions & 11 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "commitlint-dev",
"dockerComposeFile": ["../docker-compose.yml"],
"service": "commitlint",
"workspaceFolder": "/root/repo",
"shutdownAction": "stopCompose",
"extensions": [
"editorconfig.editorconfig",
"ms-vsliveshare.vsliveshare-pack",
"ms-azuretools.vscode-docker",
"esbenp.prettier-vscode"
]
"name": "commitlint-dev",
"dockerComposeFile": ["../docker-compose.yml"],
"service": "commitlint",
"workspaceFolder": "/root/repo",
"shutdownAction": "stopCompose",
"extensions": [
"editorconfig.editorconfig",
"ms-vsliveshare.vsliveshare-pack",
"ms-azuretools.vscode-docker",
"esbenp.prettier-vscode"
]
}
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab

[{.*rc,*.yml,*.md,package.json,lerna.json,tsconfig.json,tsconfig.*.json,*.svg}]
[{.*rc,*.yml,*.md,*.json,*.svg}]
indent_style = space

[*.md]
Expand Down
20 changes: 10 additions & 10 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Expand Down
53 changes: 29 additions & 24 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,52 +6,57 @@ Yeay! You want to contribute to commitlint. That's amazing!
To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.

## Found an Issue?

Thank you for reporting any issues you find. We do our best to test and make commitlint as solid as possible, but any reported issue is a real help.

> commitlint issues
Please follow these guidelines when reporting issues:
* Provide a title in the format of `<Error> when <Task>`
* Tag your issue with the tag `bug`
* Provide a short summary of what you are trying to do
* Provide the log of the encountered error if applicable
* Provide the exact version of commitlint. Check `npm ls @commitlint/cli` when in doubt
* Be awesome and consider contributing a [pull request](#want-to-contribute)

- Provide a title in the format of `<Error> when <Task>`
- Tag your issue with the tag `bug`
- Provide a short summary of what you are trying to do
- Provide the log of the encountered error if applicable
- Provide the exact version of commitlint. Check `npm ls @commitlint/cli` when in doubt
- Be awesome and consider contributing a [pull request](#want-to-contribute)

## Want to contribute?

You consider contributing changes to commitlint – we dig that!
Please consider these guidelines when filing a pull request:

> commitlint pull requests
* Follow the [Coding Rules](#coding-rules)
* Follow the [Commit Rules](#commit-rules)
* Make sure you rebased the current master branch when filing the pull request
* Squash your commits when filing the pull request
* Provide a short title with a maximum of 100 characters
* Provide a more detailed description containing
* What you want to achieve
* What you changed
* What you added
* What you removed
- Follow the [Coding Rules](#coding-rules)
- Follow the [Commit Rules](#commit-rules)
- Make sure you rebased the current master branch when filing the pull request
- Squash your commits when filing the pull request
- Provide a short title with a maximum of 100 characters
- Provide a more detailed description containing
_ What you want to achieve
_ What you changed
_ What you added
_ What you removed

## Coding Rules

To keep the code base of commitlint neat and tidy the following rules apply to every change

> Coding standards
* `prettier` is king
* Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
* Be awesome
- `prettier` is king
- Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
- Be awesome

## Commit Rules

To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
To make your life easier commitlint is commitizen-friendly and provides the npm run-script `commit`.

> Commit standards
* [conventional-changelog](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/prompt)
* husky commit message hook available
* present tense
* maximum of 100 characters
* message format of `$type($scope): $message`
- [conventional-changelog](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/prompt)
- husky commit message hook available
- present tense
- maximum of 100 characters
- message format of `$type($scope): $message`
30 changes: 18 additions & 12 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
<!--- Provide a general summary of the issue in the Title above -->

## Expected Behavior

<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior

<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Affected packages
* [ ] cli
* [ ] core
* [ ] prompt
* [ ] config-angular

- [ ] cli
- [ ] core
- [ ] prompt
- [ ] config-angular

## Possible Solution

<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)

<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

1. First step
2. Second step

<details>
<summary>commitlint.config.js</summary>
Expand All @@ -35,14 +39,16 @@
</details>

## Context

<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Your Environment

<!--- Include as many relevant details about the environment you experienced the bug in -->

| Executable | Version |
| ---: | :--- |
| Executable | Version |
| ---------------------: | :------ |
| `commitlint --version` | VERSION |
| `git --version` | VERSION |
| `node --version` | VERSION |
| `git --version` | VERSION |
| `node --version` | VERSION |
12 changes: 9 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,44 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Usage examples

<!--- Provide examples of intended usage -->

```js
// commitlint.config.js
module.exports = {

};
module.exports = {};
```

```sh
echo "your commit message here" | commitlint # fails/passes
```

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
lib/
CHANGELOG.md
27 changes: 11 additions & 16 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,16 @@
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Jest Test Current file",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"cwd": "${workspaceFolder}",
"args": [
"--runInBand",
"--no-cache",
"--no-coverage",
"${fileBasename}"
],
"sourceMaps": true,
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen"
}
{
"type": "node",
"request": "launch",
"name": "Jest Test Current file",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"cwd": "${workspaceFolder}",
"args": ["--runInBand", "--no-cache", "--no-coverage", "${fileBasename}"],
"sourceMaps": true,
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen"
}
]
}
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"typescript.tsdk": "node_modules/typescript/lib"
}
"typescript.tsdk": "node_modules/typescript/lib"
}
8 changes: 4 additions & 4 deletions @commitlint/cli/fixtures/husky/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"scripts": {},
"devDependencies": {
"husky": "4.2.1"
}
"scripts": {},
"devDependencies": {
"husky": "4.2.1"
}
}
8 changes: 4 additions & 4 deletions @commitlint/cli/fixtures/signoff/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"scripts": {},
"devDependencies": {
"husky": "4.2.1"
}
"scripts": {},
"devDependencies": {
"husky": "4.2.1"
}
}
2 changes: 1 addition & 1 deletion @commitlint/config-angular-type-enum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ echo "build: bar" | commitlint # passes

```js
// commitlint.config.js
const types = require("@commitlint/config-angular-type-enum");
const types = require('@commitlint/config-angular-type-enum');

// Use as rule creating errors for non-allowed types
module.exports = {
Expand Down

0 comments on commit dc77563

Please sign in to comment.