From 85e04000665db3140bd4b76fa7d71eb15360ea59 Mon Sep 17 00:00:00 2001 From: Noah Chen Date: Mon, 27 Feb 2017 21:37:15 -0500 Subject: [PATCH] Update docs (#2259) - sync with changes made to gh-pages branch - Update release notes to note AbstractWalker --- .gitignore | 2 +- CHANGELOG.md | 2 ++ docs/_data/develop_sidebar.json | 8 ++++++++ docs/_sass/_cayman.scss | 6 +++++- docs/css/main.scss | 7 ++++--- docs/rules/index.html | 22 +++++++++++++++++++++ docs/rules/no-unused-this/index.html | 28 --------------------------- docs/usage/third-party-tools/index.md | 6 ++++++ scripts/generate-changelog.ts | 1 + 9 files changed, 49 insertions(+), 33 deletions(-) create mode 100644 docs/rules/index.html delete mode 100644 docs/rules/no-unused-this/index.html diff --git a/.gitignore b/.gitignore index ec83b7c5002..8a0d1147a6e 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,4 @@ typings/.basedir.ts *.swp docs/_data/rules.json -docs/rules/ +docs/rules/*/index.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 69532cfc2b0..2ce247f59ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,8 @@ v4.5.0 - [enhancement] Don't exit when a rule requires type checking but type checking is not enabled (#2188) - [enhancement] `no-switch-case-fallthrough` allow single line comment `// falls through` (#2218) - [enhancement] `no-unbound-method` allows property access and binary expressions (#2143) +- [api] Introduce `AbstractWalker` for performance (#2093) + - see [performance] (https://palantir.github.io/tslint/develop/custom-rules/performance.html) and [migration] (https://palantir.github.io/tslint/develop/custom-rules/migration.html) docs Thanks to our contributors! diff --git a/docs/_data/develop_sidebar.json b/docs/_data/develop_sidebar.json index 1af6e2f92a8..d083ccfa97b 100644 --- a/docs/_data/develop_sidebar.json +++ b/docs/_data/develop_sidebar.json @@ -6,6 +6,14 @@ "title": "Custom Rules", "url": "/custom-rules/" }, + { + "title": "Custom Rules - Performance", + "url": "/custom-rules/performance.html" + }, + { + "title": "Custom Rules - Migrating to AbstractWalker", + "url": "/custom-rules/performance/migration.html" + }, { "title": "Custom Formatters", "url": "/custom-formatters/" diff --git a/docs/_sass/_cayman.scss b/docs/_sass/_cayman.scss index 41bbb75b37e..265338c51bc 100644 --- a/docs/_sass/_cayman.scss +++ b/docs/_sass/_cayman.scss @@ -39,6 +39,10 @@ a { &:hover { text-decoration: underline; } + + &:visited { + color: $link-visited-color; + } } h1 { font-size: 2.5rem; } @@ -493,4 +497,4 @@ float: left; @include small { float: left; } -} \ No newline at end of file +} diff --git a/docs/css/main.scss b/docs/css/main.scss index 75f9efad894..50119f13693 100755 --- a/docs/css/main.scss +++ b/docs/css/main.scss @@ -12,9 +12,10 @@ $base-font-size: 16px; $small-font-size: $base-font-size * 0.875; $base-line-height: 1.5; -$text-color: #606c71; -$link-color: #1e6bb8; -$heading-color: #159957; +$heading-color: #159957; +$text-color: #606c71; +$link-color: #1e6bb8; +$link-visited-color: #7d0ce8; // Import partials from `sass_dir` (defaults to `_sass`) @import diff --git a/docs/rules/index.html b/docs/rules/index.html new file mode 100644 index 00000000000..537271b7ba2 --- /dev/null +++ b/docs/rules/index.html @@ -0,0 +1,22 @@ +--- +layout: page +title: Rules +permalink: /rules/ +menu: main +order: 2 +--- +

TypeScript Specific

+

These rules find errors related to TypeScript features:

+{% include rule_list.html ruleType="typescript" %} + +

Functionality

+

These rules catch common errors in JS programming or otherwise confusing constructs that are prone to producing bugs:

+{% include rule_list.html ruleType="functionality" %} + +

Maintainability

+

These rules make code maintenance easier:

+{% include rule_list.html ruleType="maintainability" %} + +

Style

+

These rules enforce consistent style across your codebase:

+{% include rule_list.html ruleType="style" %} diff --git a/docs/rules/no-unused-this/index.html b/docs/rules/no-unused-this/index.html deleted file mode 100644 index 85b84209125..00000000000 --- a/docs/rules/no-unused-this/index.html +++ /dev/null @@ -1,28 +0,0 @@ ---- -ruleName: no-unused-this -description: Warns for methods that do not use 'this'. -optionsDescription: |- - - "allow-public" excludes public methods. - "allow-protected" excludes protected methods. -options: - type: string - enum: - - allow-public - - allow-protected -optionExamples: - - 'true' - - '[true, "allow-public", "allow-protected"]' -type: style -typescriptOnly: false -layout: rule -title: 'Rule: no-unused-this' -optionsJSON: |- - { - "type": "string", - "enum": [ - "allow-public", - "allow-protected" - ] - } ---- \ No newline at end of file diff --git a/docs/usage/third-party-tools/index.md b/docs/usage/third-party-tools/index.md index 661a1bc2c74..e11e3125de4 100644 --- a/docs/usage/third-party-tools/index.md +++ b/docs/usage/third-party-tools/index.md @@ -16,6 +16,8 @@ _Note: Most of these tools are not maintained by TSLint._ * [syntastic][10] ([VIM][11]) * [Web Analyzer][12] ([Visual Studio][13]) * [Webstorm][14] +* [mocha-tslint][15] ([Mocha][16]) +* [tslint.tmbundle][17] ([TextMate][18]) [0]: https://github.com/palantir/grunt-tslint @@ -33,3 +35,7 @@ _Note: Most of these tools are not maintained by TSLint._ [12]: https://visualstudiogallery.msdn.microsoft.com/6edc26d4-47d8-4987-82ee-7c820d79be1d [13]: https://www.visualstudio.com/ [14]: https://www.jetbrains.com/help/webstorm/2016.1/tslint.html +[15]: https://github.com/t-sauer/mocha-tslint +[16]: https://mochajs.org/ +[17]: https://github.com/natesilva/tslint.tmbundle +[18]: https://macromates.com diff --git a/scripts/generate-changelog.ts b/scripts/generate-changelog.ts index 049f3ef9d24..8fe98387ff9 100644 --- a/scripts/generate-changelog.ts +++ b/scripts/generate-changelog.ts @@ -48,6 +48,7 @@ const auth: GitHubApi.Auth = { }; console.log("Using OAuth token " + auth.token + "\n"); +// process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"; // ignores TLS certificate error github.authenticate(auth); const commits: ICommit[] = [];