Skip to content

chore(website): add details to Configurations page - #5719

Merged
bradzacher merged 8 commits into
typescript-eslint:mainfrom
JoshuaKGoldberg:docs-configs-details
Nov 23, 2022
Merged

bradzacher merged 8 commits into
typescript-eslint:mainfrom
JoshuaKGoldberg:docs-configs-details

Conversation

@JoshuaKGoldberg

Copy link
Copy Markdown
Member

PR Checklist

Overview

Reworks the Configurations page to emphasize the recommended configs. Also mention the all and base configs alongside eslint-recommended as "other" (utility) configs, and adds the Prettified, stringified contents of each config to the page.

@nx-cloud

nx-cloud Bot commented Oct 3, 2022 •

Copy link
Copy Markdown

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 473794e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@typescript-eslint

Copy link
Copy Markdown
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify

netlify Bot commented Oct 3, 2022 •

Copy link
Copy Markdown

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 473794e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6356e6c8981ddb0008e05b25
😎 Deploy Preview https://deploy-preview-5719--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JoshuaKGoldberg
JoshuaKGoldberg marked this pull request as ready for review October 16, 2022 02:50

@bradzacher bradzacher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the build is failing.

[!] Error: 'Linter' is not exported by ../../node_modules/eslint/lib/api.js, imported by src/linter/linter.js
https://rollupjs.org/guide/en/#error-name-is-not-exported-by-module
src/linter/linter.js (2:0)
1: import 'vs/language/typescript/tsWorker';
2: import { Linter } from 'eslint';
   ^
3: import rules from '@typescript-eslint/eslint-plugin/dist/rules';
Error: 'Linter' is not exported by ../../node_modules/eslint/lib/api.js, imported by src/linter/linter.js
    at error (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:198:30)
    at Module.error (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:12560:16)
    at Module.traceVariable (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:12919:29)
    at ModuleScope.findVariable (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:11571:39)
    at FunctionScope.findVariable (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:6503:38)
    at ChildScope.findVariable (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:6503:38)
    at Identifier.bind (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:7570:40)
    at NewExpression.bind (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:5400:23)
    at VariableDeclarator.bind (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:5400:23)
    at VariableDeclaration.bind (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/rollup/dist/shared/rollup.js:5396:73)

Something in this PR has introduced the error I think cos it's not broken on main

@bradzacher bradzacher added awaiting response Issues waiting for a reply from the OP or another party documentation Documentation ("docs") that needs adding/updating labels Oct 24, 2022
Comment thread docs/linting/CONFIGURATIONS.mdx Resolved
Comment thread docs/linting/CONFIGURATIONS.mdx Resolved
@JoshuaKGoldberg

Copy link
Copy Markdown
Member Author

Grr, I was really hoping that config was from some kind of caching issue.

@JoshuaKGoldberg
JoshuaKGoldberg marked this pull request as draft October 24, 2022 19:15
@JoshuaKGoldberg
JoshuaKGoldberg marked this pull request as ready for review October 24, 2022 19:26
@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 26, 2022
@bradzacher
bradzacher merged commit c4ba387 into typescript-eslint:main Nov 23, 2022
@JoshuaKGoldberg
JoshuaKGoldberg deleted the docs-configs-details branch November 24, 2022 02:36
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Dec 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Documentation ("docs") that needs adding/updating

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

Docs: Add pages for the contents of configurations to the website?

2 participants