diff options
Diffstat (limited to 'node_modules/tslint/README.md')
| -rw-r--r-- | node_modules/tslint/README.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/node_modules/tslint/README.md b/node_modules/tslint/README.md index 50575e9b5..648054338 100644 --- a/node_modules/tslint/README.md +++ b/node_modules/tslint/README.md @@ -12,23 +12,22 @@ TSLint supports: - custom lint rules - custom formatters (failure reporters) -- inline disabling and enabling of rules -- configuration presets (`tslint:latest`, `tslint-react`, etc.) & composition +- inline disabling and enabling of rules with comment flags +- configuration presets (`tslint:latest`, `tslint-react`, etc.) and plugin composition - automatic fixing of formatting & style violations -- integration with [msbuild](https://github.com/joshuakgoldberg/tslint.msbuild), [grunt](https://github.com/palantir/grunt-tslint), [gulp](https://github.com/panuhorsmalahti/gulp-tslint), [atom](https://github.com/AtomLinter/linter-tslint), [eclipse](https://github.com/palantir/eclipse-tslint), [emacs](http://flycheck.org), [sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [vim](https://github.com/scrooloose/syntastic), [visual studio](https://visualstudiogallery.msdn.microsoft.com/6edc26d4-47d8-4987-82ee-7c820d79be1d), [vscode](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [webstorm](https://www.jetbrains.com/webstorm/help/tslint.html), and more +- integration with [MSBuild](https://github.com/joshuakgoldberg/tslint.msbuild), [Grunt](https://github.com/palantir/grunt-tslint), [Gulp](https://github.com/panuhorsmalahti/gulp-tslint), [Atom](https://github.com/AtomLinter/linter-tslint), [Eclipse](https://github.com/palantir/eclipse-tslint), [Emacs](http://flycheck.org), [Sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [Vim](https://github.com/scrooloose/syntastic), [Visual Studio 2015](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.WebAnalyzer), [Visual Studio 2017](https://marketplace.visualstudio.com/items?itemName=RichNewman.TypeScriptAnalyzer) [Visual Studio code](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [WebStorm](https://www.jetbrains.com/webstorm/help/tslint.html) and [more](https://palantir.github.io/tslint/usage/third-party-tools/) Installation & Usage ------------ -Refer to the full installation & usage documentation on the [TSLint website](https://palantir.github.io/tslint/). - -There, you'll find information about +Please refer to the full installation & usage documentation on the [TSLint website](https://palantir.github.io/tslint/). There, you'll find information about - [configuration](https://palantir.github.io/tslint/usage/configuration/), -- [core rules](https://palantir.github.io/tslint/), -- [core formatters](http://palantir.github.io/tslint/formatters/), and +- [core rules](https://palantir.github.io/tslint/rules/), +- [core formatters](https://palantir.github.io/tslint/formatters/), and - [customization of TSLint](https://palantir.github.io/tslint/develop/custom-rules/). +- [inline disabling and enabling of rules with comment flags](https://palantir.github.io/tslint/usage/rule-flags/) -Custom Rules +Custom Rules & Plugins ------------ #### Custom rule sets from Palantir @@ -38,7 +37,7 @@ Custom Rules #### Custom rule sets from the community -If we don't have all the rules you're looking for, you can either write your own custom rules or use custom rules that others have developed. The repos below are a good source of custom rules: +If we don't have all the rules you're looking for, you can either write your own [custom rules](https://palantir.github.io/tslint/develop/custom-rules/) or use rules implementations developed by the community. The repos below are a good source of custom rules: - [ESLint rules for TSLint](https://github.com/buzinas/tslint-eslint-rules) - Improve your TSLint with the missing ESLint Rules - [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib) - A set of TSLint rules used on some Microsoft projects @@ -53,13 +52,13 @@ Development Requirements: - `node` v7 -- `yarn` v0.18 +- `yarn` v0.23+ #### Quick Start ```bash git clone git@github.com:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf -yarn install +yarn yarn compile yarn test ``` @@ -67,9 +66,12 @@ yarn test Creating a new release ---------------------- -1. Bump the version number in `package.json` and `src/tslintMulti.ts` +1. Bump the version number in `package.json` and `src/linter.ts` 2. Add release notes in `CHANGELOG.md` -3. `yarn verify` to build the latest sources + - Use `./scripts/generate-changelog.js` (after building it with `tsc -p scripts`) to generate the changelog diff. This script expects a Github.com personal access token to exist at `~/github_token.txt` with "repo" permissions. 4. Commit with message `Prepare release <version>` -5. Run `npm publish` -6. Create a git tag for the new release and push it ([see existing tags here](https://github.com/palantir/tslint/tags)) +5. Push your branch to GitHub and make a PR +6. Once your PR is merged, wait for the tests to pass on CircleCI for develop +7. Create a "Release" on GitHub with the proper tag version and notes from the changelog. + - The tag should be identical to the version in `package.json` +8. Run `yarn run publish:local`
\ No newline at end of file |