Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Update docs #2259

Merged
merged 1 commit into from
Feb 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ typings/.basedir.ts
*.swp

docs/_data/rules.json
docs/rules/
docs/rules/*/index.html
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
8 changes: 8 additions & 0 deletions docs/_data/develop_sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down
6 changes: 5 additions & 1 deletion docs/_sass/_cayman.scss
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ a {
&:hover {
text-decoration: underline;
}

&:visited {
color: $link-visited-color;
}
}

h1 { font-size: 2.5rem; }
Expand Down Expand Up @@ -493,4 +497,4 @@ float: left;
@include small {
float: left;
}
}
}
7 changes: 4 additions & 3 deletions docs/css/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 22 additions & 0 deletions docs/rules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: page
title: Rules
permalink: /rules/
menu: main
order: 2
---
<h3>TypeScript Specific</h3>
<p><em>These rules find errors related to TypeScript features:</em></p>
{% include rule_list.html ruleType="typescript" %}

<h3>Functionality</h3>
<p><em>These rules catch common errors in JS programming or otherwise confusing constructs that are prone to producing bugs:</em></p>
{% include rule_list.html ruleType="functionality" %}

<h3>Maintainability</h3>
<p><em>These rules make code maintenance easier:</em></p>
{% include rule_list.html ruleType="maintainability" %}

<h3>Style</h3>
<p><em>These rules enforce consistent style across your codebase:</em></p>
{% include rule_list.html ruleType="style" %}
28 changes: 0 additions & 28 deletions docs/rules/no-unused-this/index.html

This file was deleted.

6 changes: 6 additions & 0 deletions docs/usage/third-party-tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
1 change: 1 addition & 0 deletions scripts/generate-changelog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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[] = [];
Expand Down