Skip to content

Commit

Permalink
chore: setup prettier (#566)
Browse files Browse the repository at this point in the history
* chore: setup prettier

* fix package-lock.json

* add .prettierignore and fix format:fix prettier
  • Loading branch information
rafaelss95 authored and mgechev committed Apr 25, 2018
1 parent e9f4d23 commit 2184b91
Show file tree
Hide file tree
Showing 141 changed files with 10,839 additions and 5,268 deletions.
1 change: 1 addition & 0 deletions .prettierignore
@@ -0,0 +1 @@
package.json
4 changes: 4 additions & 0 deletions .prettierrc
@@ -0,0 +1,4 @@
{
"printWidth": 140,
"singleQuote": true
}
6 changes: 3 additions & 3 deletions .travis.yml
@@ -1,7 +1,7 @@
language: node_js

node_js:
- 5
- '8.11.1'
- stable
os:
- linux
Expand All @@ -10,7 +10,7 @@ os:
branches:
only: master

before_install: npm i rxjs@5.0.1 @angular/core @angular/compiler zone.js@0.7.2
before_install: npm i rxjs@6.0.0-beta.0 @angular/core@6.0.0-rc.0 @angular/compiler@6.0.0-rc.0 zone.js@0.8.20

script: npm run tscv && npm run lint && npm t
script: npm run tscv && npm run format:check && npm run lint && npm t

5 changes: 0 additions & 5 deletions .vscode/settings.json

This file was deleted.

310 changes: 153 additions & 157 deletions CHANGELOG.md

Large diffs are not rendered by default.

98 changes: 55 additions & 43 deletions CONTRIBUTING.md
Expand Up @@ -3,41 +3,43 @@
We would love for you to contribute to Codelyzer and help make it even better than it is
today! As a contributor, here are the guidelines we would like you to follow:

- [Question or Problem?](#question)
- [Issues and Bugs](#issue)
- [Feature Requests](#feature)
- [Submission Guidelines](#submit)
- [Coding Rules](#rules)
- [Commit Message Guidelines](#commit)
* [Question or Problem?](#question)
* [Issues and Bugs](#issue)
* [Feature Requests](#feature)
* [Submission Guidelines](#submit)
* [Coding Rules](#rules)
* [Commit Message Guidelines](#commit)

## <a name="question"></a> Got a Question or Problem?

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](stackoverflow.com/questions/tagged/codelyzer) where the questions should be tagged with tag `codelyzer`.

StackOverflow is a much better place to ask questions since:

- there are thousands of people willing to help on StackOverflow
- questions and answers stay available for public viewing so your question / answer might help someone else
- StackOverflow's voting system assures that the best answers are prominently visible.
* there are thousands of people willing to help on StackOverflow
* questions and answers stay available for public viewing so your question / answer might help someone else
* StackOverflow's voting system assures that the best answers are prominently visible.

To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.

If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].

## <a name="issue"></a> Found an Bug?

If you find a bug in the source code, you can help us by
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
[submit a Pull Request](#submit-pr) with a fix.

## <a name="feature"></a> Missing a Feature?
You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
Repository. If you would like to *implement* a new feature, please submit an issue with

You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub
Repository. If you would like to _implement_ a new feature, please submit an issue with
a proposal for your work first, to be sure that we can use it.
Please consider what kind of change it is:

* For a **Major Feature**, first open an issue and outline your proposal so that it can be
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).

## <a name="submit"></a> Submission Guidelines
Expand All @@ -48,10 +50,10 @@ Before you submit an issue, please search the issue tracker, maybe an issue for

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario by providing a snippet which breaks any of the codelyzer rules. Also make sure that you list:

- version of Codelyzer used
- version of Angular used
- 3rd-party libraries and their versions
- and most importantly - a use-case that fails
* version of Codelyzer used
* version of Angular used
* 3rd-party libraries and their versions
* and most importantly - a use-case that fails

You can file new issues by filling out our [new issue form](https://github.com/mgechev/codelyzer/issues/new).

Expand All @@ -69,29 +71,31 @@ Before you submit your Pull Request (PR) consider the following guidelines:
that relates to your submission. You don't want to duplicate effort.
* Make your changes in a new git branch:

```shell
git checkout -b my-fix-branch master
```
```shell
git checkout -b my-fix-branch master
```

* Create your patch, **including appropriate test cases**.
* Follow our [Coding Rules](#rules).
* Commit your changes using a descriptive commit message that follows our
[commit message conventions](#commit). Adherence to these conventions
is necessary because release notes are automatically generated from these messages.

```shell
git commit -a
```
```shell
git commit -a
```

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Push your branch to GitHub:

```shell
git push origin my-fix-branch
```
```shell
git push origin my-fix-branch
```

* In GitHub, send a pull request to `codelyzer:master`.
* If we suggest changes then:

* Make the required updates.
* Re-run the Codelyzer test and lint suites to ensure tests are still passing and you're following the coding style.
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
Expand All @@ -110,42 +114,44 @@ from the main (upstream) repository:

* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

```shell
git push origin --delete my-fix-branch
```
```shell
git push origin --delete my-fix-branch
```

* Check out the master branch:

```shell
git checkout master -f
```
```shell
git checkout master -f
```

* Delete the local branch:

```shell
git branch -D my-fix-branch
```
```shell
git branch -D my-fix-branch
```

* Update your master with the latest upstream version:

```shell
git pull --ff upstream master
```
```shell
git pull --ff upstream master
```

## <a name="rules"></a> Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

* All features or bug fixes **must be tested** by one or more specs (unit-tests).
* We follow [Google's JavaScript Style Guide][js-style-guide].

## <a name="commit"></a> Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to **more
readable messages** that are easy to follow when looking through the **project history**. But also,
We have very precise rules over how our git commit messages can be formatted. This leads to **more
readable messages** that are easy to follow when looking through the **project history**. But also,
we use the git commit messages to **generate the Angular change log**.

### Commit Message Format
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:

```
Expand All @@ -168,16 +174,19 @@ Samples: (even more [samples](https://github.com/mgechev/codelyzer/commits/maste
```
docs(changelog): update change log to beta.5
```

```
fix(release): need to depend on latest rxjs and zone.js
The version in our package.json gets copied to the one we publish, and users need the latest of these.
```

### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

### Type

Must be one of the following:

* **feat**: A new feature
Expand All @@ -192,21 +201,25 @@ Must be one of the following:
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

### Scope

The scope could be anything specifying place of the commit change. For example
`ngWalker`, `useLifeCycleInterface`, etc.

### Subject

The subject contains succinct description of the change:

* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize first letter
* no dot (.) at the end

### Body

Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.

### Footer

The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.

Expand All @@ -217,4 +230,3 @@ A detailed explanation can be found in this [document][commit-message-format].
[github]: https://github.com/mgechev/codelyzer
[gitter]: https://gitter.im/mgechev/codelyzer
[stackoverflow]: http://stackoverflow.com/questions/tagged/codelyzer

0 comments on commit 2184b91

Please sign in to comment.