docs: draft of new typescript-eslint website #3147

armano2 · 2021-03-04T17:36:11Z

There is a lot of stuff that still has to be done, but this draft is in sufficient enough state that feedback is welcome.

preview of current version can be seen at https://typescript-eslint-armano.netlify.app/

REPL/Playground is now available: link

TODO:

Pages:
- Update homepage with better content
Docs:
- add configs to rules
- update "ESLint Plugin" guide
- add more docs
Playgrund
- add way to load config instead of drop-down with rules
- add button to generate markdown to copy/paste in tickets
- in options add dropdown to pick typescript version
- align syntax highlighting between prisim, editor and ast viewer (each uses now different stylesheet)
- AST viewer should expand childs when needed
- add more tsconfig options
- add ability to print ast as json
- move linting to service worker

suppressed by #4108

Conflicts: yarn.lock

…lected

Conflicts: yarn.lock

bradzacher · 2021-03-31T22:27:18Z

Okay - I've thought about this some more and I think we should just treat the GH repo as code.
Lets work towards separating out all docs in their entirety into the new folder.

I.e. rip them out of the individual packages.

This is what other OSS projects do, so I don't know why we should be any different!
TBH - I also don't see any tangible value in co-locating the docs with the packages.

Links on the NPM package pages are broken anyways because NPM doesn't respect its own repository.directory field (even though it's clearly documented on their website 😠 ) - so updating the readme to link out to the website won't ultimately make anything worse.

Doing this will mean we no longer have to do any dodgy stuff to make these website frameworks work.
It also means that we can prioritise writing documentation around the single usecase - which will reduce the maintenance burden significantly.

JoshuaKGoldberg · 2021-10-25T00:56:24Z

website/static/img/typescript.svg

+<svg xmlns="http://www.w3.org/2000/svg" version="1.0" width="266.667" height="266.667" viewBox="0 0 200 200">
+  <rect fill="#fff" width="199" height="199" />
+  <path d="M0 100v100h200V0H0zm164.5-6.092c5.815 2.224 11.628 9.183 13.5 11.492-1.518 1.358-11.225 8.685-12.634 9.766-.724-.499-2.433-1.932-4.666-3.666-3.128-2.428-4.3-3.5-7.5-3.5-7.6 0-11.8 6.8-7.8 12.6.8 1.1 7.5 5 14.9 8.7 19.1 9.4 23.7 15.1 23.7 29.3-.1 10.3-5.3 17.9-15.5 22.6-3.66 1.318-6.7 2.3-15 2.2-11.7 0-20.1-3.4-25.3-7.9-4.805-4.667-7.62-10.04-8.1-10.9.789-.507 3.6-2.2 7.4-4.4l6.98-4.158 3.32 3.858c8.6 10.4 27.2 9 27.2-2 0-4.7-4.1-8.3-13.8-12.3-3.7-1.5-9.1-4.2-12-5.9-19-11.3-18.5-36.9.8-45.6 5.7-2.6 16.585-3.673 24.5-.192zM115 101v8H89v74H71v-74H44c-.174-5.462 0-9.941.006-16.118L115 93z" fill="#443fd4"/>
+</svg>


Nit: this and logo.svg are the same; can they be deduplicated?

JoshuaKGoldberg · 2021-10-25T01:00:14Z

website/docusaurus.config.js

+          position: 'left',
+        },
+        {
+          to: 'repl',


Nit: can we call this /play to match up with typescriptlang.org/play?

REPL to me implies Eval and Print in the CLI sense.

JoshuaKGoldberg · 2021-10-25T01:00:50Z

website/docusaurus.config.js

+          to: 'repl',
+          activeBasePath: 'repl',
+          position: 'right',
+          label: 'Playground',


This playground is excellent and will make issues much easier to reproduce!... but just spitballing: since this PR has been sitting for a while, maybe we should get in the base docs in first, and tackle the playground as a followup?

nx-cloud · 2021-11-04T17:01:40Z

Nx Cloud Report

CI ran the following commands for commit c51339f. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status	Command
	`Node 12.x - nx test @typescript-eslint/eslint-plugin`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin`
	`Node 14.x - nx test @typescript-eslint/parser`
	`Node 14.x - nx test @typescript-eslint/experimental-utils`
	`Node 12.x - nx test @typescript-eslint/parser`
	`Node 14.x - nx test @typescript-eslint/scope-manager`
	`Node 12.x - nx test @typescript-eslint/experimental-utils`
	`Node 12.x - nx test @typescript-eslint/scope-manager`
	`Node 12.x - nx test @typescript-eslint/visitor-keys`
	`Node 12.x - nx test @typescript-eslint/typescript-estree`
	`Node 12.x - nx run-many --target=typecheck --all --parallel`
	`Node 14.x - nx test @typescript-eslint/visitor-keys`
	`Node 14.x - nx test @typescript-eslint/typescript-estree`
	`Node 16.x - nx test @typescript-eslint/parser`
	`Node 16.x - nx test @typescript-eslint/experimental-utils`
	`Node 12.x - nx test @typescript-eslint/parser`
	`Node 16.x - nx test @typescript-eslint/scope-manager`
	`Node 12.x - nx test @typescript-eslint/experimental-utils`
	`Node 12.x - nx test @typescript-eslint/scope-manager`
	`Node 12.x - nx test @typescript-eslint/visitor-keys`

Sent with 💌 from NxCloud.

codecov · 2021-11-04T17:04:29Z

Codecov Report

Merging #3147 (6286b12) into master (c289d13) will decrease coverage by 0.19%.
The diff coverage is n/a.

❗ Current head 6286b12 differs from pull request most recent head c51339f. Consider uploading reports for the commit c51339f to get more accurate results

@@            Coverage Diff             @@
##           master    #3147      +/-   ##
==========================================
- Coverage   93.11%   92.91%   -0.20%     
==========================================
  Files         174      316     +142     
  Lines        9619    10818    +1199     
  Branches     3004     3059      +55     
==========================================
+ Hits         8957    10052    +1095     
- Misses        248      342      +94     
- Partials      414      424      +10

Flag	Coverage Δ
unittest	`92.91% <ø> (-0.20%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ackages/eslint-plugin/src/rules/space-infix-ops.ts	`90.00% <0.00%> (-10.00%)`	⬇️
packages/eslint-plugin/src/util/requiresQuoting.ts	`90.90% <0.00%> (-9.10%)`	⬇️
packages/eslint-plugin/src/rules/dot-notation.ts	`84.21% <0.00%> (-8.39%)`	⬇️
...ackages/eslint-plugin/src/rules/keyword-spacing.ts	`92.85% <0.00%> (-7.15%)`	⬇️
...nt-plugin/src/rules/lines-between-class-members.ts	`85.71% <0.00%> (-7.15%)`	⬇️
packages/eslint-plugin/src/util/astUtils.ts	`81.81% <0.00%> (-7.08%)`	⬇️
...ackages/eslint-plugin/src/util/getWrappingFixer.ts	`93.93% <0.00%> (-6.07%)`	⬇️
...kages/eslint-plugin/src/rules/init-declarations.ts	`76.47% <0.00%> (-4.78%)`	⬇️
...rc/rules/no-unnecessary-boolean-literal-compare.ts	`89.61% <0.00%> (-3.90%)`	⬇️
...kages/eslint-plugin/src/rules/no-empty-function.ts	`77.14% <0.00%> (-2.86%)`	⬇️
... and 295 more

JoshuaKGoldberg · 2021-11-07T03:57:34Z

package.json

+  "workspaces": {
+    "packages": [
+      "packages/*",
+      "website"


Out of curiosity, why not put website/ in packages/ also?

armano2 · 2021-11-08T19:16:39Z

suppressed by #4105 and #4108

armano2 added 30 commits March 1, 2021 03:16

docs: generate simple documentation page

e7e80a2

chore: add netlify config

bacfc85

fix: update netlify config

e4e3a18

fix: remove netlify.toml

17f3ef4

fix: add sponsors to start page and update page

9bb88e5

fix: correct few minor issues

d80ce4a

docs: style improvements on homepage

21a47b0

docs: add missing dark mode logo

b0c94cc

docs: use svg files for github icon

6102904

docs: update homepage and fix hero styles

ba2f030

docs: add note about eslint core rules

695744d

docs: fix styles for dark theme

b89d9ff

docs: add tslint migration guide

84c88b1

docs: update docs

160d08d

docs: update links

05aa9b2

docs: add dynamic github url for testing

c335534

docs: wip editor

bdf68dd

docs: create basic repl

2772d85

fix: add missing package

68f35db

fix: add missing typescript

ad76d50

fix: correct build for ssr

242e431

fix: correct build for ssr and loading all rules

fbcfc41

fix: add support for quickfix

75fc69d

fix: refactor update markers

567285d

fix: setup workspaces and migrate code to typescript

35c7c3b

fix: correct build when in monorepo

241dd18

fix: reduce number of files that has to be loaded

55fad3d

fix: yarn lock after depencency update

cbe134e

Merge branch 'fix/yarn-lock'

718de5e

Conflicts: yarn.lock

Merge remote-tracking branch 'origin/master' into docs-page

af58a83

armano2 added 4 commits March 18, 2021 14:48

docs(website): fix ssr build

38c0014

docs(website): ensure that default typescript version is correctly se…

6b893bd

…lected

Merge remote-tracking branch 'refs/remotes/origin/master'

c8bc133

Conflicts: yarn.lock

docs(website): correct issue with reloading page after ts version change

2abb092

armano2 mentioned this pull request Mar 21, 2021

Support monorepos with multiple docs plugins facebook/docusaurus#4085

Open

3 tasks

docs(website): correct minor warnings and enable spelling checks

6286b12

armano2 mentioned this pull request Mar 21, 2021

feat(v2): frontmatter-less: read first heading as title and use it in front-matter facebook/docusaurus#4485

Merged

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label May 28, 2021

bradzacher added the DO NOT MERGE PRs which should not be merged yet label Jul 31, 2021

JoshuaKGoldberg reviewed Oct 25, 2021

View reviewed changes

bradzacher mentioned this pull request Oct 25, 2021

Documentation update request #3993

Closed

JoshuaKGoldberg mentioned this pull request Oct 28, 2021

Idea: playground plugin for running typescript-eslint microsoft/TypeScript-Website#2114

Closed

armano2 added 2 commits November 4, 2021 13:27

Merge branch 'master' into HEAD

b192a43

docs: update website

34e7463

JoshuaKGoldberg reviewed Nov 7, 2021

View reviewed changes

JoshuaKGoldberg mentioned this pull request Nov 7, 2021

Starting version of website with docs pages and rules #4099

Closed

3 tasks

chore: bump @babel to 7.16.x and update tests

4759724

armano2 mentioned this pull request Nov 7, 2021

chore: bump babel to 7.16.x and update tests #4101

Merged

Merge branch 'fix-babel-7_16-tests' into docs-page

c51339f

armano2 added a commit to armano2/typescript-eslint that referenced this pull request Nov 8, 2021

chore(website): migrate playground from typescript-eslint#3147

8d960ad

armano2 mentioned this pull request Nov 8, 2021

chore(website): add playground to website #4108

Merged

7 tasks

armano2 closed this Nov 8, 2021

armano2 deleted the docs-page branch November 8, 2021 19:16

github-actions bot locked as resolved and limited conversation to collaborators Dec 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: draft of new typescript-eslint website #3147

docs: draft of new typescript-eslint website #3147

armano2 commented Mar 4, 2021 •

edited

bradzacher commented Mar 31, 2021 •

edited

JoshuaKGoldberg Oct 25, 2021

JoshuaKGoldberg Oct 25, 2021

JoshuaKGoldberg Oct 25, 2021

nx-cloud bot commented Nov 4, 2021 •

edited

codecov bot commented Nov 4, 2021 •

edited

JoshuaKGoldberg Nov 7, 2021

armano2 commented Nov 8, 2021 •

edited

docs: draft of new typescript-eslint website #3147

docs: draft of new typescript-eslint website #3147

Conversation

armano2 commented Mar 4, 2021 • edited

TODO:

bradzacher commented Mar 31, 2021 • edited

JoshuaKGoldberg Oct 25, 2021

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 25, 2021

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 25, 2021

Choose a reason for hiding this comment

nx-cloud bot commented Nov 4, 2021 • edited

Nx Cloud Report

codecov bot commented Nov 4, 2021 • edited

Codecov Report

JoshuaKGoldberg Nov 7, 2021

Choose a reason for hiding this comment

armano2 commented Nov 8, 2021 • edited

armano2 commented Mar 4, 2021 •

edited

bradzacher commented Mar 31, 2021 •

edited

nx-cloud bot commented Nov 4, 2021 •

edited

codecov bot commented Nov 4, 2021 •

edited

armano2 commented Nov 8, 2021 •

edited