diff --git a/.github/workflows/deploy-website-old.yml b/.github/workflows/deploy-website-old.yml deleted file mode 100644 index 7e05dc126c..0000000000 --- a/.github/workflows/deploy-website-old.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Deploy Jekyll Website to GitHub Pages - -on: - # push: - # branches: - # - main - # paths: - # - 'docs/**' - # - 'website/**' - # - 'package.json' - # Run on demand - workflow_dispatch: - -permissions: - contents: read - -jobs: - build-and-deploy-website: - name: Build and Deploy Website - permissions: - contents: write - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - - uses: actions/setup-node@v4 - with: - node-version: 20.x - - - name: Install dependencies - run: | - npm i - cd website - npm i - - - name: Build website - run: | - cd website - npm run build - - # Popular action to deploy to GitHub Pages: - # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus - # cspell:ignore peaceiris - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - # Build output to publish to the `gh-pages` branch: - publish_dir: ./docs - # The following lines assign commit authorship to the official - # GH-Actions bot for deploys to `gh-pages` branch: - # https://github.com/actions/checkout/issues/13#issuecomment-724415212 - # The GH actions bot is used by default if you didn't specify the two fields. - # You can swap them out with your own user credentials. - user_name: github-actions[bot] - user_email: 41898282+github-actions[bot]@users.noreply.github.com - disable_nojekyll: true # cspell:ignore nojekyll diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index a145e4f66b..1019142cc4 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -2,12 +2,12 @@ name: ' 🧪 Integration Tests' on: pull_request: paths-ignore: - - 'docs/**' + - 'website/**' push: branches: - main paths-ignore: - - 'docs/**' + - 'website/**' jobs: run-integration-tests: diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 261d82c751..88dfcc6daf 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -6,17 +6,19 @@ on: # rebuild any PRs and main branch changes branches: - main paths: - - 'docs/**' + - 'website/**' jobs: cspell: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - run: npx cspell "docs/**" + - run: npx cspell website lint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - run: npx prettier -c "docs/**/*.{md,markdown,yaml,yml,json,html,htm}" + - run: | + npm i + npx prettier -c website diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f98bcc4dbd..ee9503a130 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -3,12 +3,12 @@ on: # rebuild any PRs and main branch changes workflow_dispatch: pull_request: paths-ignore: - - 'docs/**' + - 'website/**' push: branches: - main paths-ignore: - - 'docs/**' + - 'website/**' jobs: cspell: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 37261ed21b..53fd7fef0b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -2,12 +2,12 @@ name: ' 🧪 Build and Test' on: pull_request: paths-ignore: - - 'docs/**' + - 'website/**' push: branches: - main paths-ignore: - - 'docs/**' + - 'website/**' jobs: build-test: diff --git a/.gitignore b/.gitignore index 87c8d1109a..a4e95060b0 100644 --- a/.gitignore +++ b/.gitignore @@ -48,8 +48,7 @@ packages/*/out/ packages/*/temp/ tools/*/dist/ tools/*/temp/ -docs/docsV2/ - +website/build !**/server/.vscode !**/client/.vscode diff --git a/.prettierignore b/.prettierignore index 2b7986cf61..a46c6b05c1 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,8 +8,6 @@ **/yarn.lock CHANGELOG.md coverage -docs/_site -docs/docsV2 node_modules packages/_integrationTests/out/ packages/*/dist/ diff --git a/docs/.cspell.json b/docs/.cspell.json deleted file mode 100644 index df94b9dd46..0000000000 --- a/docs/.cspell.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "dictionaries": ["custom-dictionary"], - "dictionaryDefinitions": [ - { - "name": "custom-dictionary", - "path": "./.cspell/custom-dictionary.txt", - "addWords": true - } - ], - "languageSettings": [ - { - "languageId": "markdown", - "patterns": [ - { - "name": "Internal Link", - "pattern": "/(?<=\\])\\(#\\w+\\)/g" - } - ], - "ignoreRegExpList": ["Internal Link"] - } - ], - "enableFiletypes": ["ruby"], - "ignorePaths": ["_site/**", "cspell*.{json,yaml}"], - "overrides": [ - { - "filename": "**/generated-docs/configuration.md", - "ignoreWords": ["colour", "canot", "overridable", "userdata", "scminput"] - } - ] -} diff --git a/docs/.cspell/custom-dictionary.txt b/docs/.cspell/custom-dictionary.txt deleted file mode 100644 index 948f1fb619..0000000000 --- a/docs/.cspell/custom-dictionary.txt +++ /dev/null @@ -1,7 +0,0 @@ -# Custom Dictionary Words -mswin -pmarsceill -streetsidesoftware -VSIX -webrick -zoneinfo diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index f40fbd8ba5..0000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -_site -.sass-cache -.jekyll-cache -.jekyll-metadata -vendor diff --git a/docs/.prettierignore b/docs/.prettierignore deleted file mode 100644 index 6f5b04694a..0000000000 --- a/docs/.prettierignore +++ /dev/null @@ -1,3 +0,0 @@ - -_site/** -.vscode/** diff --git a/docs/.prettierrc.json b/docs/.prettierrc.json deleted file mode 100644 index 80135da711..0000000000 --- a/docs/.prettierrc.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "printWidth": 120, - "singleQuote": true, - "overrides": [ - { - "files": "**/*.{yaml,yml}", - "options": { - "singleQuote": false - } - }, - { - "files": "**/*.{html,htm}", - "options": { - "tabWidth": 2 - } - } - ] -} diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json deleted file mode 100644 index f89ed5f1d9..0000000000 --- a/docs/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "editor.formatOnSave": true -} diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index d2da569289..0000000000 --- a/docs/404.html +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: default -title: 404 -permalink: /404 -nav_exclude: true -search_exclude: true ---- - -

Page not found

- -

- The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% - endif %}to find what you're looking for or go to this site's home page. -

diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 7c86560287..0000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,41 +0,0 @@ -source "https://rubygems.org" -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! -# gem "jekyll", "~> 4.2.0" - -# This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "minima", "~> 2.5" - -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -# gem "github-pages", ">= 219", group: :jekyll_plugins -# gem "github-pages", "~> 217", group: :jekyll_plugins -gem "github-pages", ">= 231", group: :jekyll_plugins - -# If you have any plugins, put them here! -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.17" -end - -# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem -# and associated library. -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", "~> 1.2" - gem "tzinfo-data" -end - -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] - -gem "webrick", "~> 1.8" - -# Experimental theme -# gem "just-the-docs", "~> 0.3.3" - -gem "jekyll-relative-links", "~> 0.7.0" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock deleted file mode 100644 index 36b170701b..0000000000 --- a/docs/Gemfile.lock +++ /dev/null @@ -1,290 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (7.1.3) - base64 - bigdecimal - concurrent-ruby (~> 1.0, >= 1.0.2) - connection_pool (>= 2.2.5) - drb - i18n (>= 1.6, < 2) - minitest (>= 5.1) - mutex_m - tzinfo (~> 2.0) - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - base64 (0.2.0) - bigdecimal (3.1.6) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.12.2) - colorator (1.1.0) - commonmarker (0.23.10) - concurrent-ruby (1.2.3) - connection_pool (2.4.1) - dnsruby (1.70.0) - simpleidn (~> 0.2.1) - drb (2.2.0) - ruby2_keywords - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - ethon (0.16.0) - ffi (>= 1.15.0) - eventmachine (1.2.7) - execjs (2.9.1) - faraday (2.9.0) - faraday-net_http (>= 2.0, < 3.2) - faraday-net_http (3.1.0) - net-http - ffi (1.16.3) - forwardable-extended (2.6.0) - gemoji (4.1.0) - github-pages (230) - github-pages-health-check (= 1.18.2) - jekyll (= 3.9.5) - jekyll-avatar (= 0.8.0) - jekyll-coffeescript (= 1.2.2) - jekyll-commonmark-ghpages (= 0.4.0) - jekyll-default-layout (= 0.1.5) - jekyll-feed (= 0.17.0) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.16.1) - jekyll-include-cache (= 0.2.1) - jekyll-mentions (= 1.6.0) - jekyll-optional-front-matter (= 0.3.2) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.3.0) - jekyll-redirect-from (= 0.16.0) - jekyll-relative-links (= 0.7.0) - jekyll-remote-theme (= 0.4.3) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.8.0) - jekyll-sitemap (= 1.4.0) - jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.2.0) - jekyll-theme-cayman (= 0.2.0) - jekyll-theme-dinky (= 0.2.0) - jekyll-theme-hacker (= 0.2.0) - jekyll-theme-leap-day (= 0.2.0) - jekyll-theme-merlot (= 0.2.0) - jekyll-theme-midnight (= 0.2.0) - jekyll-theme-minimal (= 0.2.0) - jekyll-theme-modernist (= 0.2.0) - jekyll-theme-primer (= 0.6.0) - jekyll-theme-slate (= 0.2.0) - jekyll-theme-tactile (= 0.2.0) - jekyll-theme-time-machine (= 0.2.0) - jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.13.0) - kramdown (= 2.4.0) - kramdown-parser-gfm (= 1.1.0) - liquid (= 4.0.4) - mercenary (~> 0.3) - minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) - rouge (= 3.30.0) - terminal-table (~> 1.4) - github-pages-health-check (1.18.2) - addressable (~> 2.3) - dnsruby (~> 1.60) - octokit (>= 4, < 8) - public_suffix (>= 3.0, < 6.0) - typhoeus (~> 1.3) - html-pipeline (2.14.3) - activesupport (>= 2) - nokogiri (>= 1.4) - http_parser.rb (0.8.0) - i18n (1.14.1) - concurrent-ruby (~> 1.0) - jekyll (3.9.5) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (>= 0.7, < 2) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 2.0) - kramdown (>= 1.17, < 3) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (>= 1.7, < 4) - safe_yaml (~> 1.0) - jekyll-avatar (0.8.0) - jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.2.2) - coffee-script (~> 2.2) - coffee-script-source (~> 1.12) - jekyll-commonmark (1.4.0) - commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) - jekyll-commonmark (~> 1.4.0) - rouge (>= 2.0, < 5.0) - jekyll-default-layout (0.1.5) - jekyll (>= 3.0, < 5.0) - jekyll-feed (0.17.0) - jekyll (>= 3.7, < 5.0) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.16.1) - jekyll (>= 3.4, < 5.0) - octokit (>= 4, < 7, != 4.4.0) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-mentions (1.6.0) - html-pipeline (~> 2.3) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.16.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.7.0) - jekyll (>= 3.3, < 5.0) - jekyll-remote-theme (0.4.3) - addressable (~> 2.0) - jekyll (>= 3.5, < 5.0) - jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) - rubyzip (>= 1.3.0, < 3.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-swiss (1.0.0) - jekyll-theme-architect (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.6.0) - jekyll (> 3.5, < 5.0) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - jemoji (0.13.0) - gemoji (>= 3, < 5) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.8.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - mini_portile2 (2.8.6) - minima (2.5.1) - jekyll (>= 3.5, < 5.0) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.22.2) - mutex_m (0.2.0) - net-http (0.4.1) - uri - nokogiri (1.16.5) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) - nokogiri (1.16.5-x86_64-darwin) - racc (~> 1.4) - nokogiri (1.16.5-x86_64-linux) - racc (~> 1.4) - octokit (4.25.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (5.0.4) - racc (1.7.3) - rb-fsevent (0.11.2) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.8) - strscan (>= 3.0.9) - rouge (3.30.0) - ruby2_keywords (0.0.5) - rubyzip (2.3.2) - safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.9.2) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) - simpleidn (0.2.1) - unf (~> 0.1.4) - strscan (3.1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.1) - ethon (>= 0.9.0) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) - unf (0.1.4) - unf_ext - unf_ext (0.0.9.1) - unicode-display_width (1.8.0) - uri (0.13.0) - webrick (1.8.1) - -PLATFORMS - ruby - x86_64-darwin-20 - x86_64-linux - -DEPENDENCIES - github-pages (>= 228) - jekyll-feed (~> 0.17) - jekyll-relative-links (~> 0.7.0) - minima (~> 2.5) - tzinfo (~> 1.2) - tzinfo-data - wdm (~> 0.1.1) - webrick (~> 1.8) - -BUNDLED WITH - 2.1.4 diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 11d3358993..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# VS Code Spell Checker Documentation - -This is where the documentation is stored. - -## Run locally - -```sh -bundle exec jekyll serve -# or -yarn run serve -``` - -## Building Generated Content - -Generated content comes from the spell checker code. - -```sh -yarn run gen-docs -``` diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index bffc3ac98a..0000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,103 +0,0 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely edit after that. If you find -# yourself editing this file very often, consider using Jekyll's data files -# feature for the data you need to update frequently. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. -# -# If you need help with YAML syntax, here are some quick references for you: -# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml -# https://learnxinyminutes.com/docs/yaml/ -# -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. - -title: Spell Checker -email: &email "jason@streetsidesoftware.nl" -name: &name "Jason Dent" # &name is a YAML anchor which can be *referenced later -description: >- # this means to ignore newlines until "baseurl:" - A Spell Checker for Code! -url: https://streetsidesoftware.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" -baseurl: "/vscode-spell-checker" # the subpath of your site, e.g. "/blog" -repository: "streetsidesoftware/vscode-spell-checker" -github_username: streetsidesoftware -# twitter_username: jekyllrb -# github_username: jekyll - -# Build settings -# theme: jekyll-theme-slate -# theme: minima -remote_theme: pmarsceill/just-the-docs - -plugins: - # - jekyll-feed - - jekyll-relative-links - -# permalink: pretty -permalink: /:categories/:title/ - -# Exclude from processing. -# The following items will not be processed, by default. -# Any item listed under the `exclude:` key here will be automatically added to -# the internal "default list". -# -# Excluded items can be processed by explicitly listing the directories or -# their entries' file path in the `include:` list. -# -exclude: - - "**/.cspell.*" - - "**/.cspell/**" - - README.md -# - .sass-cache/ -# - .jekyll-cache/ -# - gemfiles/ -# - Gemfile -# - Gemfile.lock -# - node_modules/ -# - vendor/bundle/ -# - vendor/cache/ -# - vendor/gems/ -# - vendor/ruby/ - -# -# just-the-docs -# See: [Home | Just the Docs](https://pmarsceill.github.io/just-the-docs/) -# - -collections: - - docs - - drafts - - release-notes - -defaults: - - scope: - path: "assets/images" - values: - image: true - -# Aux links for the upper right navigation -aux_links: - "CSpell": - - "https://streetsidesoftware.github.io/cspell" - "GitHub": - - "https://github.com/streetsidesoftware/vscode-spell-checker" - "Issues": - - "https://github.com/streetsidesoftware/vscode-spell-checker/issues" - -# Back to top link -back_to_top: true -back_to_top_text: "Back to top" - -# Footer "Edit this page on GitHub" link text -gh_edit_link: true # show or hide edit this page link -gh_edit_link_text: "Edit this page on GitHub." -gh_edit_repository: "https://github.com/streetsidesoftware/vscode-spell-checker" # the github URL for your repo -gh_edit_branch: "main" # the branch that your docs is served from -gh_edit_source: docs # the source that your files originate from -gh_edit_view_mode: "blob" # "tree" or "edit" if you want the user to jump into the editor immediately diff --git a/docs/_includes/generated-docs/README.md b/docs/_includes/generated-docs/README.md deleted file mode 100644 index 1f6edf600a..0000000000 --- a/docs/_includes/generated-docs/README.md +++ /dev/null @@ -1,774 +0,0 @@ - - -# Spelling Checker for Visual Studio Code - -A basic spell checker that works well with code and documents. - -The goal of this spell checker is to help catch common spelling errors while keeping the number of false positives low. - -## Support Further Development - -- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](https://github.com/sponsors/streetsidesoftware) -- [![Patreon](https://img.shields.io/badge/-black?style=social&logo=patreon&label=Patreon%3A%20Street%20Side%20Software)](https://patreon.com/streetsidesoftware) -- [![PayPal](https://img.shields.io/badge/-black?style=social&logo=paypal&label=PayPal%20Donate%3A%20Street%20Side%20Software)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) -- [![Open Collective](https://img.shields.io/badge/-black?style=social&logo=opencollective&label=Open%20Collective%3A%20Code%20Spell%20Checker)](https://opencollective.com/code-spell-checker) - -## Functionality - -Load a TypeScript, JavaScript, Text, etc. file. Words not in the dictionary files will have -a squiggly underline. - -### Example - -![Example](https://raw.githubusercontent.com/streetsidesoftware/vscode-spell-checker/main/images/example.gif) - -## Suggestions - -![Example](https://raw.githubusercontent.com/streetsidesoftware/vscode-spell-checker/main/images/suggestions.gif) - -To see the list of suggestions: - -After positioning the cursor in the word, any of the following should display the list of suggestions: - -- Click on the 💡 (lightbulb) in the left hand margin. -- [`Quick Fix`](https://code.visualstudio.com/docs/getstarted/keybindings#_rich-languages-editing) Editor action command: - - Mac: `⌘`+`.` or `Cmd`+`.` - - PC: `Ctrl`+`.` - -## Install - -Open up VS Code and hit `F1` and type `ext` select install and type `code-spell-checker` hit enter and reload window to enable. - -## Supported Languages - -- English (US) -- English (GB) - turn on by changing `"cSpell.language": "en"` to `"cSpell.language": "en-GB"` - -## Add-On Dictionaries - - - -### Language Dictionaries - -- [Ancient Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ancient-greek) - Ancient Greek dictionary extension for VS Code. -- [Arabic](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-arabic) - Arabic dictionary extension for VS Code. -- [Australian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-australian-english) - Australian English dictionary extension for VS Code. -- [Austrian German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-austrian-german) - Austrian German dictionary extension for VS Code. -- [Basque](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-basque) - Basque dictionary extension for VS Code. -- [British English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-british-english) - British English dictionary extension for VS Code. -- [Bulgarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-bulgarian) - Bulgarian dictionary extension for VS Code. -- [Canadian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-canadian-english) - Canadian English dictionary extension for VS Code. -- [Catalan](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-catalan) - Catalan dictionary extension for VS Code. -- [Croatian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-croatian) - Croatian dictionary extension for VS Code. -- [Czech](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-czech) - Czech dictionary extension for VS Code. -- [Danish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-danish) - Danish dictionary extension for VS Code. -- [Dutch](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-dutch) - Dutch / Nederlands dictionary extension for VS Code. -- [Esperanto](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-esperanto) - Esperanto dictionary extension for VS Code. -- [Estonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-estonian) - Estonian dictionary extension for VS Code. -- [Finnish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-finnish) - Finnish dictionary extension for VS Code. -- [French](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french) - French dictionary extension for VS Code. -- [French Réforme 90](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french-reforme) - French Réforme 90 dictionary extension for VS Code. -- [German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-german) - German dictionary extension for VS Code. -- [Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-greek) - Greek dictionary extension for VS Code. -- [Hebrew](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hebrew) - Hebrew dictionary extension for VS Code. -- [Hungarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hungarian) - Hungarian dictionary extension for VS Code. -- [Indonesian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-indonesian) - Indonesian dictionary extension for VS Code. -- [Italian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-italian) - Italian dictionary extension for VS Code. -- [Latin](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latin) - Latin dictionary extension for VS Code. -- [Latvian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latvian) - Latvian dictionary extension for VS Code. -- [Lithuanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-lithuanian) - Lithuanian dictionary extension for VS Code. -- [Norwegian Bokmål](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-norwegian-bokmal) - Norwegian Bokmål dictionary extension for VS Code. -- [Persian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-persian) - Persian dictionary extension for VS Code. -- [Polish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-polish) - Polish dictionary extension for VS Code. -- [Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese) - Portuguese dictionary extension for VS Code. -- [Brazilian Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese-brazilian) - Brazilian Portuguese dictionary extension for VS Code. -- [Romanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-romanian) - Romanian dictionary extension for VS Code. -- [Russian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) - Russian dictionary extension for VS Code. -- [Serbian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-serbian) - Serbian dictionary extension for VS Code. -- [Slovak](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovak) - Slovak dictionary extension for VS Code. -- [Slovenian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovenian) - Slovenian dictionary extension for VS Code. -- [Spanish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-spanish) - Spanish Add-On for Code Spell Checker -- [Swedish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swedish) - Swedish dictionary extension for VS Code. -- [Swiss German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swiss-german) - Swiss German dictionary extension for VS Code. -- [Turkish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-turkish) - Turkish dictionary extension for VS Code. -- [Ukrainian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ukrainian) - Ukrainian dictionary extension for VS Code. -- [Vietnamese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-vietnamese) - Vietnamese dictionary extension for VS Code. - -### Technical Dictionaries - -- [Medical Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-medical-terms) - Medical Terms Add-On for Code Spell Checker -- [Scientific Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-scientific-terms) - Scientific Terms dictionary extension for VS Code. -- [Win32](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-win32) - Win32 dictionary extension for VS Code. - - - -## Enabled File Types - -- AsciiDoc -- C, C++ -- C# -- css, less, scss -- Dart -- Elixir -- Go -- Html -- Java -- JavaScript -- JSON / JSONC -- LaTeX -- Markdown -- PHP -- PowerShell -- Pug / Jade -- Python -- reStructuredText -- Ruby -- Rust -- Scala -- Text -- TypeScript -- YAML -- SQL - -### Enable / Disable File Types - -To _Enable_ or _Disable_ spell checking for a file type: - -1. Click on the Spell Checker status in the status bar: - - Spell Checker Status Bar - -2. On the Info screen, click the checkbox. - - Spell Checker Information Window - -## How it works with camelCase - -The concept is simple, split camelCase words before checking them against a list of known English words. - -- camelCase -> camel case -- HTMLInput -> html input -- Notice that the `I` is associated with `Input` and not `HTML` -- snake_case_words -> snake case words -- camel2snake -> camel snake -- (the 2 is ignored) - -### Special case with ALL CAPS words - -There are a few special cases to help with common spelling practices for ALL CAPS words. - -Trailing `s`, `ing`, `ies`, `es`, `ed` are kept with the previous word. - -- CURLs -> curls -- trailing `s` -- CURLedRequest -> curled request -- trailing `ed` - -## Things to note - -- This spellchecker is case insensitive. It will not catch errors like english which should be English. -- The spellchecker uses a local word dictionary. It does not send anything outside your machine. -- The words in the dictionary can and do contain errors. -- There are missing words. -- Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries. -- All symbols and punctuation are ignored. - -## In Document Settings - -It is possible to add spell check settings into your source code. -This is to help with file specific issues that may not be applicable to the entire project. - -All settings are prefixed with `cSpell:` or `spell-checker:`. - -- `disable` -- turn off the spell checker for a section of code. -- `enable` -- turn the spell checker back on after it has been turned off. -- `ignore` -- specify a list of words to be ignored. -- `words` -- specify a list of words to be considered correct and will appear in the suggestions list. -- `locale` -- set locale (example: `cSpell:locale fr,en` to use French and English languages) -- `ignoreRegExp` -- Any text matching the regular expression will NOT be checked for spelling. -- `includeRegExp` -- Only text matching the collection of includeRegExp will be checked. -- `enableCompoundWords` / `disableCompoundWords` -- Allow / disallow words like: "stringlength". - -### Enable / Disable checking sections of code - -It is possible to disable / enable the spell checker by adding comments to your code. - -#### Disable Checking - -- `cSpell:disable` -- `spell-checker: disable` -- `spellchecker: disable` -- `cspell: disable-line` -- `cspell: disable-next-line` - - - -#### Enable Checking - -- `cSpell:enable` -- `spell-checker: enable` -- `spellchecker: enable` - -#### JavaScript Example - -```javascript -// cSpell:disable -const wackyWord = ['zaallano', 'wooorrdd', 'zzooommmmmmmm']; -/* cSpell:enable */ - -// Nest disable / enable is not Supported - -// spell-checker:disable -// It is now disabled. - -var liep = 1; - -/* cspell:disable */ -// It is still disabled - -// cSpell:enable -// It is now enabled - -const str = 'goededag'; // <- will be flagged as an error. - -// spell-checker:enable <- doesn't do anything - -// cSPELL:DISABLE <-- also works. - -// if there isn't an enable, spelling is disabled till the end of the file. -const str = 'goedemorgen'; // <- will NOT be flagged as an error. -``` - - - -#### Markdown Example - -```markdown - - -This text is not checked. - - - -This text is checked. -``` - -### Ignore - -Ignore allows you the specify a list of words you want to ignore within the document. - -```javascript -// cSpell:ignore zaallano, wooorrdd -// cSpell:ignore zzooommmmmmmm -const wackyWord = ['zaallano', 'wooorrdd', 'zzooommmmmmmm']; -``` - -**Note:** words defined with `ignore` will be ignored for the entire file. - -### Words - -The words list allows you to add words that will be considered correct and will be used as suggestions. - -```javascript -// cSpell:words woorxs sweeetbeat -const companyName = 'woorxs sweeetbeat'; -``` - -**Note:** words defined with `words` will be used for the entire file. - -### Enable / Disable compound words - -In some programming language it is common to glue words together. - -```c -// cSpell:enableCompoundWords -char * errormessage; // Is ok with cSpell:enableCompoundWords -int errornumber; // Is also ok. -``` - -**Note:** Compound word checking cannot be turned on / off in the same file. -The last setting in the file determines the value for the entire file. - -### Excluding and Including Text to be checked. - -By default, the entire document is checked for spelling. -`cSpell:disable`/`cSpell:enable` above allows you to block off sections of the document. -`ignoreRegExp` and `includeRegExp` give you the ability to ignore or include patterns of text. -By default the flags `gim` are added if no flags are given. - -The spell checker works in the following way: - -1. Find all text matching `includeRegExp` -1. Remove any text matching `excludeRegExp` -1. Check the remaining text. - -#### Exclude Example - -```javascript -// cSpell:ignoreRegExp 0x[0-9a-f]+ -- will ignore c style hex numbers -// cSpell:ignoreRegExp /0x[0-9A-F]+/g -- will ignore upper case c style hex numbers. -// cSpell:ignoreRegExp g{5} h{5} -- will only match ggggg, but not hhhhh or 'ggggg hhhhh' -// cSpell:ignoreRegExp g{5}|h{5} -- will match both ggggg and hhhhh -// cSpell:ignoreRegExp /g{5} h{5}/ -- will match 'ggggg hhhhh' -/* cSpell:ignoreRegExp /n{5}/ -- will NOT work as expected because of the ending comment -> */ -/* - cSpell:ignoreRegExp /q{5}/ -- will match qqqqq just fine but NOT QQQQQ -*/ -// cSpell:ignoreRegExp /[^\s]{40,}/ -- will ignore long strings with no spaces. -// cSpell:ignoreRegExp Email -- this will ignore email like patterns -- see Predefined RegExp expressions -var encodedImage = 'HR+cPzr7XGAOJNurPL0G8I2kU0UhKcqFssoKvFTR7z0T3VJfK37vS025uKroHfJ9nA6WWbHZ/ASn...'; -var email1 = 'emailaddress@myfancynewcompany.com'; -var email2 = ''; -``` - -**Note:** ignoreRegExp and includeRegExp are applied to the entire file. They do not start and stop. - -#### Include Example - -In general you should not need to use `includeRegExp`. But if you are mixing languages then it could come in helpful. - -```Python -# cSpell:includeRegExp #.* -# cSpell:includeRegExp /(["]{3}|[']{3})[^\1]*?\1/g -# only comments and block strings will be checked for spelling. -def sum_it(self, seq): - """This is checked for spelling""" - variabele = 0 - alinea = 'this is not checked' - for num in seq: - # The local state of 'value' will be retained between iterations - variabele += num - yield variabele -``` - -## Predefined RegExp expressions - -### Exclude patterns - -- `Urls`1 -- Matches urls -- `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134` -- `EscapeCharacters`1 -- matches special characters: `\n`, `\t` etc. -- `Base64`1 -- matches base64 blocks of text longer than 40 characters. -- `Email` -- matches most email addresses. - -### Include Patterns - -- `Everything`1 -- By default we match an entire document and remove the excludes. -- `string` -- This matches common string formats like '...', "...", and \`...\` -- `CStyleComment` -- These are C Style comments /\* \*/ and // -- `PhpHereDoc` -- This matches PHPHereDoc strings. - -1. These patterns are part of the default include/exclude list for every file. - -## Customization - -The spell checker configuration can be controlled via VS Code preferences or `cspell.json` configuration file. - -Order of precedence: - -1. Workspace Folder `cspell.json` -1. Workspace Folder `.vscode/cspell.json` -1. VS Code Preferences `cSpell` section. - -### Adding words to the Workspace Dictionary - -You have the option to add you own words to the workspace dictionary. The easiest, is to put your cursor -on the word you wish to add, when you lightbulb shows up, hit `Ctrl+.` (windows) / `Cmd+.` (Mac). You will get a list -of suggestions and the option to add the word. - -You can also type in a word you want to add to the dictionary: `F1` `add word` -- select `Add Word to Dictionary` and type in the word you wish to add. - -### cspell.json - -Words added to the dictionary are placed in the `cspell.json` file in the _workspace_ folder. -Note, the settings in `cspell.json` will override the equivalent cSpell settings in VS Code's `settings.json`. - -#### Example _cspell.json_ file - -```javascript -// cSpell Settings -{ - // Version of the setting file. Always 0.2 - "version": "0.2", - // language - current active spelling language - "language": "en", - // words - list of words to be always considered correct - "words": [ - "mkdirp", - "tsmerge", - "githubusercontent", - "streetsidesoftware", - "vsmarketplacebadge", - "visualstudio" - ], - // flagWords - list of words to be always considered incorrect - // This is useful for offensive words and common spelling errors. - // For example "hte" should be "the" - "flagWords": [ - "hte" - ] -} -``` - -### VS Code Configuration Settings - -```javascript - //-------- Code Spell Checker Configuration -------- - // The Language locale to use when spell checking. "en", "en-US" and "en-GB" are currently supported by default. - "cSpell.language": "en", - - // Controls the maximum number of spelling errors per document. - "cSpell.maxNumberOfProblems": 100, - - // Controls the number of suggestions shown. - "cSpell.numSuggestions": 8, - - // The minimum length of a word before checking it against a dictionary. - "cSpell.minWordLength": 4, - - // Specify file types to spell check. - "cSpell.enabledLanguageIds": [ - "csharp", - "go", - "javascript", - "javascriptreact", - "markdown", - "php", - "plaintext", - "typescript", - "typescriptreact", - "yml", - "sql" - ], - - // Enable / Disable the spell checker. - "cSpell.enabled": true, - - // Display the spell checker status on the status bar. - "cSpell.showStatus": true, - - // Words to add to dictionary for a workspace. - "cSpell.words": [], - - // Enable / Disable compound words like 'errormessage' - "cSpell.allowCompoundWords": false, - - // Words to be ignored and not suggested. - "cSpell.ignoreWords": ["behaviour"], - - // User words to add to dictionary. Should only be in the user settings. - "cSpell.userWords": [], - - // Specify paths/files to ignore. - "cSpell.ignorePaths": [ - "node_modules", // this will ignore anything the node_modules directory - "**/node_modules", // the same for this one - "**/node_modules/**", // the same for this one - "node_modules/**", // Doesn't currently work due to how the current working directory is determined. - "vscode-extension", // - ".git", // Ignore the .git directory - "*.dll", // Ignore all .dll files. - "**/*.dll" // Ignore all .dll files - ], - - // flagWords - list of words to be always considered incorrect - // This is useful for offensive words and common spelling errors. - // For example "hte" should be "the"` - "cSpell.flagWords": ["hte"], - - // Set the delay before spell checking the document. Default is 50. - "cSpell.spellCheckDelayMs": 50, - - // Set Diagnostic Reporting Level - // Error - Report Spelling Issues as Errors - // Warning - Report Spelling Issues as Warnings - // Information - Report Spelling Issues as Information (default) - // Hint - Report Spelling Issues as Hints, will not show up in Problems - "cSpell.diagnosticLevel": "Information", -``` - -## Dictionaries - -The spell checker includes a set of default dictionaries. - -### General Dictionaries - -- **wordsEn** - Derived from Hunspell US English words. -- **wordsEnGb** - Derived from Hunspell GB English words. -- **companies** - List of well known companies -- **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc. -- **misc** - Terms that do not belong in the other dictionaries. - -### Programming Language Dictionaries - -- **typescript** - keywords for Typescript and Javascript -- **node** - terms related to using nodejs. -- **php** - _php_ keywords and library methods -- **go** - _go_ keywords and library methods -- **python** - _python_ keywords -- **powershell** - _powershell_ keywords -- **html** - _html_ related keywords -- **css** - _css_, _less_, and _scss_ related keywords - -### Miscellaneous Dictionaries - -- **fonts** - long list of fonts - to assist with _css_ - -Based upon the programming language, different dictionaries will be loaded. - -Here are some of the default rules: - -- `"*"` matches any programming language / file type. -- `"locale"` is used to filter based upon the `"cSpell.language"` setting. - -```javascript -{ -"cSpell.languageSettings": [ - { "languageId": '*', "locale": 'en', "dictionaries": ['wordsEn'] }, - { "languageId": '*', "locale": 'en-US', "dictionaries": ['wordsEn'] }, - { "languageId": '*', "locale": 'en-GB', "dictionaries": ['wordsEnGb'] }, - { "languageId": '*', "dictionaries": ['companies', 'softwareTerms', 'misc'] }, - { "languageId": "python", "dictionaries": ["python"]}, - { "languageId": "go", "dictionaries": ["go"] }, - { "languageId": "javascript", "dictionaries": ["typescript", "node"] }, - { "languageId": "javascriptreact", "dictionaries": ["typescript", "node"] }, - { "languageId": "typescript", "dictionaries": ["typescript", "node"] }, - { "languageId": "typescriptreact", "dictionaries": ["typescript", "node"] }, - { "languageId": "html", "dictionaries": ["html", "fonts", "typescript", "css"] }, - { "languageId": "php", "dictionaries": ["php", "html", "fonts", "css", "typescript"] }, - { "languageId": "css", "dictionaries": ["fonts", "css"] }, - { "languageId": "less", "dictionaries": ["fonts", "css"] }, - { "languageId": "scss", "dictionaries": ["fonts", "css"] }, -]; -} -``` - -### How to add your own Dictionaries - -#### `cSpell.customDictionaries` - -````ts -interface Settings { - 'cSpell.customDictionaries': { - [name: string]: CustomDictionary; - }; -} - -interface CustomDictionary { - /** - * @title Name of Dictionary - * The reference name of the dictionary. - * - * - * Example: `My Words` or `custom` - * - * - * If they name matches a pre-defined dictionary, it will override the pre-defined dictionary. - * If you use: `typescript` it will replace the built-in TypeScript dictionary. - */ - name?: DictionaryId; - - /** - * @title Description of the Dictionary - * Optional: A human readable description. - */ - description?: string; - - /** - * @title Path to Dictionary Text File - * Define the path to the dictionary text file. - * - * - * **Note:** if path is `undefined` the `name`d dictionary is expected to be found - * in the `dictionaryDefinitions`. - * - * - * File Format: Each line in the file is considered a dictionary entry. - * Case is preserved while leading and trailing space is removed. - * The path should be absolute, or relative to the workspace. - * - * **Example:** relative to User's folder - * - * ``` - * ~/dictionaries/custom_dictionary.txt - * ``` - * - * **Example:** relative to the `client` folder in a multi-root workspace - * - * ``` - * ${workspaceFolder:client}/build/custom_dictionary.txt - * ``` - * - * **Example:** relative to the current workspace folder in a single-root workspace - * - * **Note:** this might no as expected in a multi-root workspace since it is based upon the relative - * workspace for the currently open file. - * - * ``` - * ${workspaceFolder}/build/custom_dictionary.txt - * ``` - * - * **Example:** relative to the workspace folder in a single-root workspace or the first folder in - * a multi-root workspace - * - * ``` - * ./build/custom_dictionary.txt - * ``` - */ - path?: FsPath; - - /** - * @title Add Words to Dictionary - * Indicate if this custom dictionary should be used to store added words. - * @default true - */ - addWords?: boolean; - - /** - * @title Scope of dictionary - * Options are - * - `user` - words that apply to all projects and workspaces - * - `workspace` - words that apply to the entire workspace - * - `folder` - words that apply to only a workspace folder - */ - scope?: CustomDictionaryScope | CustomDictionaryScope[]; -} -```` - -#### Global Dictionary - -To add a global dictionary, you will need change your user settings. - -##### Define the Dictionary - -In your user settings, you will need to tell the spell checker where to find your word list. - -Example adding medical terms, so words like _acanthopterygious_ can be found. - -**VS Code Settings** - -```js -"cSpell.customDictionaries": { - "myWords": { - "name": "myWords", - "path": "~/my-words.txt", - "scope": "user", - "addWords": true - } -} -``` - -**Explained:** In this example, we have told the spell checker where to find our personal dictionary called `myWords`. - -- `name` - this is the name of the dictionary, all references to this dictionary is done by the name. -- `path` - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using `~/`. -- `scope` - (Optional) this is used to "scope" a dictionary to `user`, `workspace`, or `folder`. Scope is used to help communicate the intended use of the dictionary. -- `addWords` - (Optional) default - `true` - is used to show / hide the dictionary as a possible target for adding words. - -#### Project / Workspace Dictionary using `cspell.json` - -To add a dictionary at the project level should be defined in a `cspell.json` file so it can be used with the `cspell` command line tool. -This file can be either at the project root or in the .vscode directory. - -Example adding medical terms, where the terms are checked into the project and we only want to use it for .md files. - -```javascript -{ - "dictionaryDefinitions": [ - { "name": "medicalTerms", "path": "./dictionaries/medicalterms-en.txt"}, - { "name": "cities", "path": "./dictionaries/cities.txt"} - ], - "dictionaries": [ - "cities" - ], - "languageSettings": [ - { "languageId": "markdown", "dictionaries": ["medicalTerms"] }, - { "languageId": "plaintext", "dictionaries": ["medicalTerms"] } - ] -} -``` - -**Explained:** In this example, two dictionaries were defined: _cities_ and _medicalTerms_. -The paths are relative to the location of the _cSpell.json_ file. This allows for dictionaries to be checked into the project. - -The _cities_ dictionary is used for every file type, because it was added to the list to _dictionaries_. -The _medicalTerms_ dictionary is only used when editing _markdown_ or _plaintext_ files. - -**DictionaryDefinition** - -```ts -interface DictionaryDefinition { - /** - * This is the name of a dictionary. - * - * Name Format: - * - Must contain at least 1 number or letter. - * - Spaces are allowed. - * - Leading and trailing space will be removed. - * - Names ARE case-sensitive. - * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. - */ - name: DictionaryId; - /** Optional description. */ - description?: string; - /** Path to custom dictionary text file. */ - path: CustomDictionaryPath; - /** - * Defines the scope for when words will be added to the dictionary. - * Scope values: `user`, `workspace`, `folder`. - */ - scope?: CustomDictionaryScope | CustomDictionaryScope[]; - /** - * When `true`, let's the spell checker know that words can be added to this dictionary. - */ - addWords: boolean; -} -``` - -#### Project / Workspace Dictionary using VS Code Settings - -**VS Code Settings** - -```js -"cSpell.customDictionaries": { - "project-words": { - "name": "project-words", - "path": "${workspaceRoot}/project-words.txt", - "description": "Words used in this project", - "addWords": true - }, - "medicalTerms": { - "name": "medicalTerms", - "path": "/Users/guest/projects/cSpell-WordLists/dictionaries/medicalterms-en.txt", - "addWords": false // Do not add words to this dictionary - }, - "companyTerms": { - "name": "companyTerms", - "path": "${workspaceFolder}/../company/terms.txt" - // "addWords": true -- is implied - }, - "custom": true, // Enable the `custom` dictionary - "internal-terms": false // Disable the `internal-terms` dictionary -} -``` - -## FAQ - -See: [FAQ](https://github.com/streetsidesoftware/vscode-spell-checker/blob/main/FAQ.md) - - - -
- ---- - -

Brought to you by Street Side Software Logo Street Side Software

- - diff --git a/docs/_includes/generated-docs/commands.md b/docs/_includes/generated-docs/commands.md deleted file mode 100644 index 60fb077da2..0000000000 --- a/docs/_includes/generated-docs/commands.md +++ /dev/null @@ -1,60 +0,0 @@ - - -# Commands - -| Command | Title | -| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `cSpell.addIgnoreWord` | Ignore Words | -| `cSpell.addIgnoreWordsToFolder` | Ignore Word in Folder Settings | -| `cSpell.addIgnoreWordsToUser` | Ignore Words in User Settings | -| `cSpell.addIgnoreWordsToWorkspace` | Ignore Words in Workspace Settings | -| `cSpell.addIssuesToDictionary` | Add All Spelling Issues to Dictionary | -| `cSpell.addWordToCSpellConfig` | Add Words to CSpell Configuration | -| `cSpell.addWordToDictionary` | Add Words to Dictionary | -| `cSpell.addWordToFolderDictionary` | Add Words to Folder Dictionary | -| `cSpell.addWordToFolderSettings` | Add Words to Folder Settings | -| `cSpell.addWordToUserDictionary` | Add Words to User Dictionary | -| `cSpell.addWordToUserSettings` | Add Words to User Settings | -| `cSpell.addWordToWorkspaceDictionary` | Add Words to Workspace Dictionary | -| `cSpell.addWordToWorkspaceSettings` | Add Words to Workspace Settings | -| `cSpell.autoFixSpellingIssues` | Fix all issues with a preferred suggestion in the current document. | -| `cSpell.createCSpellConfig` | Create a CSpell Configuration File. | -| `cSpell.createCSpellTerminal` | Create CSpell REPL Terminal | -| `cSpell.createCustomDictionary` | Create a Custom Dictionary File. | -| `cSpell.disableCurrentFileType` | Disable Spell Checking File Type | -| `cSpell.disableCurrentLanguage` | Disable Spell Checking Document Type | -| `cSpell.disableForGlobal` | Disable Spell Checking by Default | -| `cSpell.disableForWorkspace` | Disable Spell Checking For Workspace | -| `cSpell.displayCSpellInfo` | Show Spell Checker Configuration Info | -| `cSpell.enableCurrentFileType` | Enable Spell Checking File Type | -| `cSpell.enableCurrentLanguage` | Enable Spell Checking Document Type | -| `cSpell.enableForGlobal` | Enable Spell Checking by Default | -| `cSpell.enableForWorkspace` | Enable Spell Checking For Workspace | -| `cSpell.goToNextSpellingIssue` | Go to Next Spelling Issue | -| `cSpell.goToNextSpellingIssueAndSuggest` | Go to Next Spelling Issue and Suggest | -| `cSpell.goToPreviousSpellingIssue` | Go to Previous Spelling Issue | -| `cSpell.goToPreviousSpellingIssueAndSuggest` | Go to Previous Spelling Issue and Suggest | -| `cSpell.hide` | Hide Spelling Issues | -| `cSpell.insertDisableLineDirective` | Insert Disable Current Line Directive | -| `cSpell.insertDisableNextLineDirective` | Insert Disable Next Line Directive | -| `cSpell.insertIgnoreWordsDirective` | Insert Ignore Words Directive | -| `cSpell.insertWordsDirective` | Insert Words Directive | -| `cSpell.issuesViewByFile.item.addWordToDictionary` | Add Word to Dictionary
**When:**
`view == cSpellIssuesViewByFile` | -| `cSpell.issuesViewByFile.item.autoFixSpellingIssues` | Fix issue with preferred suggestion in the current document.
**When:**
`view == cSpellIssuesViewByFile` | -| `cSpell.issueViewer.item.addWordToDictionary` | Add Word to Dictionary
**When:**
`view == cSpellIssuesViewByIssue` | -| `cSpell.issueViewer.item.autoFixSpellingIssues` | Fix issue with preferred suggestion in the current document.
**When:**
`view == cSpellIssuesViewByIssue` | -| `cSpell.issueViewer.item.openSuggestionsForIssue` | Show Suggestions
**When:**
`view == cSpellIssuesViewByIssue` | -| `cSpell.logPerfTimeline` | Log CSpell performance times to console | -| `cSpell.openFileInfoView` | Open Spell Checker File Information View | -| `cSpell.openIssuesPanel` | Open Spell Checker Issues Panel | -| `cSpell.removeWordFromFolderDictionary` | Remove Words from the Folder Dictionary | -| `cSpell.removeWordFromUserDictionary` | Remove Words from the Global Dictionary | -| `cSpell.removeWordFromWorkspaceDictionary` | Remove Words from the Workspace Dictionaries | -| `cSpell.restart` | Restart Spell Checker Server | -| `cSpell.show` | Show Spelling Issues | -| `cSpell.suggestSpellingCorrections` | Spelling Suggestions...
**When:**
`editorTextFocus && cSpell.editorMenuContext.showSuggestions` | -| `cSpell.toggleEnableForGlobal` | Toggle Spell Checking in User Settings | -| `cSpell.toggleEnableForWorkspace` | Toggle Spell Checking for Workspace | -| `cSpell.toggleEnableSpellChecker` | Toggle Spell Checking | -| `cSpell.toggleTraceMode` | Toggle Trace Mode | -| `cSpell.toggleVisible` | Toggle Show Spelling Issues | diff --git a/docs/_includes/generated-docs/configuration.md b/docs/_includes/generated-docs/configuration.md deleted file mode 100644 index 8cc65226f7..0000000000 --- a/docs/_includes/generated-docs/configuration.md +++ /dev/null @@ -1,2293 +0,0 @@ - - -# Configuration Settings - -- [Code Spell Checker](#code-spell-checker) -- [Languages and Dictionaries](#languages-and-dictionaries) -- [Reporting and Display](#reporting-and-display) -- [Files, Folders, and Workspaces](#files-folders-and-workspaces) -- [Performance](#performance) -- [CSpell](#cspell) -- [Appearance](#appearance) -- [Advanced](#advanced) -- [Experimental](#experimental) -- [Legacy](#legacy) - -# Code Spell Checker - -| Setting | Scope | Description | -| ---------------------------------- | -------- | ----------------------------------- | -| [`cSpell.enabled`](#cspellenabled) | resource | Enable / Disable the spell checker. | - -## Definitions - -### `cSpell.enabled` - -Name -: `cSpell.enabled` - -Type -: `boolean` - -Scope -: resource - -Description -: Enable / Disable the spell checker. - -Default -: _`true`_ - ---- - -# Languages and Dictionaries - -| Setting | Scope | Description | -| -------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------- | -| [`cSpell.caseSensitive`](#cspellcasesensitive) | resource | Determines if words must match case and accent rules. | -| [`cSpell.customDictionaries`](#cspellcustomdictionaries) | resource | Custom Dictionaries | -| [`cSpell.dictionaries`](#cspelldictionaries) | resource | Optional list of dictionaries to use. | -| [`cSpell.dictionaryDefinitions`](#cspelldictionarydefinitions) | resource | Dictionary Definitions | -| [`cSpell.flagWords`](#cspellflagwords) | resource | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [`cSpell.ignoreWords`](#cspellignorewords) | resource | A list of words to be ignored by the spell checker. | -| [`cSpell.language`](#cspelllanguage) | resource | Current active spelling language. | -| [`cSpell.languageSettings`](#cspelllanguagesettings) | resource | Additional settings for individual programming languages and locales. | -| [`cSpell.noSuggestDictionaries`](#cspellnosuggestdictionaries) | resource | Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries… | -| [`cSpell.suggestWords`](#cspellsuggestwords) | | A list of suggested replacements for words. Suggested words provide a way to make preferred… | -| [`cSpell.userWords`](#cspelluserwords) | resource | Words to add to global dictionary -- should only be in the user config file. | -| [`cSpell.words`](#cspellwords) | resource | List of words to be considered correct. | - -## Definitions - -### `cSpell.caseSensitive` - -Name -: `cSpell.caseSensitive` - -Type -: `boolean` - -Scope -: resource - -Description -: Determines if words must match case and accent rules. - - - `false` - Case is ignored and accents can be missing on the entire word. - Incorrect accents or partially missing accents will be marked as incorrect. - Note: Some languages like Portuguese have case sensitivity turned on by default. - You must use `#cSpell.languageSettings#` to turn it off. - - `true` - Case and accents are enforced by default. - -Default -: _- none -_ - ---- - -### `cSpell.customDictionaries` - -Name -: `cSpell.customDictionaries` -- Custom Dictionaries - -Type -: `object` - -Scope -: resource - -Description -: Define custom dictionaries to be included by default. -If `addWords` is `true` words will be added to this dictionary. - - **Example:** - - ```js - "cSpell.customDictionaries": { - "project-words": { - "name": "project-words", - "path": "${workspaceRoot}/project-words.txt", - "description": "Words used in this project", - "addWords": true - }, - "custom": true, // Enable the `custom` dictionary - "internal-terms": false // Disable the `internal-terms` dictionary - } - ``` - -Default -: _- none -_ - ---- - -### `cSpell.dictionaries` - -Name -: `cSpell.dictionaries` - -Type -: `string[]` - -Scope -: resource - -Description -: Optional list of dictionaries to use. - - Each entry should match the name of the dictionary. - - To remove a dictionary from the list add `!` before the name. - i.e. `!typescript` will turn off the dictionary with the name `typescript`. - - - Example: - - ```jsonc - // Enable `lorem-ipsum` and disable `typescript` - "cSpell.dictionaries": ["lorem-ipsum", "!typescript"] - ``` - -Default -: _- none -_ - ---- - -### `cSpell.dictionaryDefinitions` - -Name -: `cSpell.dictionaryDefinitions` -- Dictionary Definitions - -Type -: `object[]` - -Scope -: resource - -Description -: Define custom dictionaries.. -If `addWords` is `true` words will be added to this dictionary. - - This setting is subject to User/Workspace settings precedence rules: [Visual Studio Code User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings#_settings-precedence). - - It is better to use `#cSpell.customDictionaries#` - - **Example:** - - ```js - "cSpell.dictionaryDefinitions": [ - { - "name": "project-words", - "path": "${workspaceRoot}/project-words.txt", - "description": "Words used in this project", - "addWords": true - } - ] - ``` - -Default -: _- none -_ - ---- - -### `cSpell.flagWords` - -Name -: `cSpell.flagWords` - -Type -: `string[]` - -Scope -: resource - -Description -: List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` - -Default -: _- none -_ - ---- - -### `cSpell.ignoreWords` - -Name -: `cSpell.ignoreWords` - -Type -: `string[]` - -Scope -: resource - -Description -: A list of words to be ignored by the spell checker. - -Default -: _- none -_ - ---- - -### `cSpell.language` - -Name -: `cSpell.language` - -Type -: `string` - -Scope -: resource - -Description -: Current active spelling language. - - Example: "en-GB" for British English - - Example: "en,nl" to enable both English and Dutch - -Default -: _`"en"`_ - ---- - -### `cSpell.languageSettings` - -Name -: `cSpell.languageSettings` - -Type -: `object[]` - -Scope -: resource - -Description -: Additional settings for individual programming languages and locales. - -Default -: _- none -_ - ---- - -### `cSpell.noSuggestDictionaries` - -Name -: `cSpell.noSuggestDictionaries` - -Type -: `string[]` - -Scope -: resource - -Description -: Optional list of dictionaries that will not be used for suggestions. -Words in these dictionaries are considered correct, but will not be -used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - one of these dictionaries, it will be removed from the set of - possible suggestions. - -Default -: _- none -_ - ---- - -### `cSpell.suggestWords` - -Name -: `cSpell.suggestWords` - -Type -: `string[]` - -Scope -: _- none -_ - -Description -: A list of suggested replacements for words. -Suggested words provide a way to make preferred suggestions on word replacements. -To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` - -Default -: _- none -_ - ---- - -### `cSpell.userWords` - -Name -: `cSpell.userWords` - -Type -: `string[]` - -Scope -: resource - -Description -: Words to add to global dictionary -- should only be in the user config file. - -Default -: _- none -_ - ---- - -### `cSpell.words` - -Name -: `cSpell.words` - -Type -: `string[]` - -Scope -: resource - -Description -: List of words to be considered correct. - -Default -: _- none -_ - ---- - -# Reporting and Display - -| Setting | Scope | Description | -| ------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------------------- | -| [`cSpell.autoFormatConfigFile`](#cspellautoformatconfigfile) | window | Auto Format Configuration File | -| [`cSpell.diagnosticLevel`](#cspelldiagnosticlevel) | resource | Set Diagnostic Reporting Level | -| [`cSpell.diagnosticLevelFlaggedWords`](#cspelldiagnosticlevelflaggedwords) | resource | Set Diagnostic Reporting Level for Flagged Words | -| [`cSpell.hideAddToDictionaryCodeActions`](#cspellhideaddtodictionarycodeactions) | resource | Hide the options to add words to dictionaries or settings. | -| [`cSpell.hideIssuesWhileTyping`](#cspellhideissueswhiletyping) | machine | Hide Issues While Typing | -| [`cSpell.maxDuplicateProblems`](#cspellmaxduplicateproblems) | resource | The maximum number of times the same word can be flagged as an error in a file. | -| [`cSpell.maxNumberOfProblems`](#cspellmaxnumberofproblems) | resource | Controls the maximum number of spelling errors per document. | -| [`cSpell.minWordLength`](#cspellminwordlength) | resource | The minimum length of a word before checking it against a dictionary. | -| [`cSpell.numSuggestions`](#cspellnumsuggestions) | resource | Controls the number of suggestions shown. | -| [`cSpell.revealIssuesAfterDelayMS`](#cspellrevealissuesafterdelayms) | machine | Reveal Issues After a Delay in Milliseconds | -| [`cSpell.showAutocompleteDirectiveSuggestions`](#cspellshowautocompletedirectivesuggestions) | language-overridable | Show CSpell in-document directives as you type. | -| [`cSpell.showCommandsInEditorContextMenu`](#cspellshowcommandsineditorcontextmenu) | application | Show Spell Checker actions in Editor Context Menu | -| [`cSpell.showStatus`](#cspellshowstatus) | application | Display the spell checker status on the status bar. | -| [`cSpell.showStatusAlignment`](#cspellshowstatusalignment) | application | The side of the status bar to display the spell checker status. | -| [`cSpell.showSuggestionsLinkInEditorContextMenu`](#cspellshowsuggestionslinkineditorcontextmenu) | application | Show Spelling Suggestions link in the top level context menu. | -| [`cSpell.suggestionMenuType`](#cspellsuggestionmenutype) | resource | The type of menu used to display spelling suggestions. | -| [`cSpell.suggestionNumChanges`](#cspellsuggestionnumchanges) | resource | The maximum number of changes allowed on a word to be considered a suggestions. | -| [`cSpell.validateDirectives`](#cspellvalidatedirectives) | window | Verify that the in-document directives are correct. | - -## Definitions - -### `cSpell.autoFormatConfigFile` - -Name -: `cSpell.autoFormatConfigFile` -- Auto Format Configuration File - -Type -: `boolean` - -Scope -: window - -Description -: If a `cspell` configuration file is updated, format the configuration file -using the VS Code Format Document Provider. This will cause the configuration -file to be saved prior to being updated. - -Default -: _`false`_ - ---- - -### `cSpell.diagnosticLevel` - -Name -: `cSpell.diagnosticLevel` -- Set Diagnostic Reporting Level - - -Type -: `( "Error" | "Warning" | "Information" | "Hint" )` - - | `Error` | Report Spelling Issues as Errors | - | `Warning` | Report Spelling Issues as Warnings | - | `Information` | Report Spelling Issues as Information | - | `Hint` | Report Spelling Issues as Hints, will not show up in Problems | - - - -Scope -: resource - -Description -: The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. -Set the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#` -to control how issues are displayed in the document. - - See: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity) - -Default -: _`"Information"`_ - ---- - -### `cSpell.diagnosticLevelFlaggedWords` - -Name -: `cSpell.diagnosticLevelFlaggedWords` -- Set Diagnostic Reporting Level for Flagged Words - - -Type -: `( "Error" | "Warning" | "Information" | "Hint" )` - - | `Error` | Report Spelling Issues as Errors | - | `Warning` | Report Spelling Issues as Warnings | - | `Information` | Report Spelling Issues as Information | - | `Hint` | Report Spelling Issues as Hints, will not show up in Problems | - - - -Scope -: resource - -Description -: Flagged word issues found by the spell checker are marked with a Diagnostic Severity Level. This affects the color of the squiggle. -By default, flagged words will use the same diagnostic level as general issues. Use this setting to customize them. - - See: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity) - -Default -: _- none -_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.hideAddToDictionaryCodeActions` - -Name -: `cSpell.hideAddToDictionaryCodeActions` - -Type -: `boolean` - -Scope -: resource - -Description -: Hide the options to add words to dictionaries or settings. - -Default -: _`false`_ - ---- - -### `cSpell.hideIssuesWhileTyping` - -Name -: `cSpell.hideIssuesWhileTyping` -- Hide Issues While Typing - - -Type -: `( "Off" | "Word" | "Line" | "Document" )` - - | `Off` | Show issues while typing | - | `Word` | Hide issues while typing in the current word | - | `Line` | Hide issues while typing on the line | - | `Document` | Hide all issues while typing in the document | - - - -Scope -: machine - -Description -: Control how spelling issues are displayed while typing. -See: `#cSpell.revealIssuesAfterMS#` to control when issues are revealed. - -Default -: _`"Word"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.maxDuplicateProblems` - -Name -: `cSpell.maxDuplicateProblems` - -Type -: `number` - -Scope -: resource - -Description -: The maximum number of times the same word can be flagged as an error in a file. - -Default -: _`20`_ - ---- - -### `cSpell.maxNumberOfProblems` - -Name -: `cSpell.maxNumberOfProblems` - -Type -: `number` - -Scope -: resource - -Description -: Controls the maximum number of spelling errors per document. - -Default -: _`100`_ - ---- - -### `cSpell.minWordLength` - -Name -: `cSpell.minWordLength` - -Type -: `number` - -Scope -: resource - -Description -: The minimum length of a word before checking it against a dictionary. - -Default -: _`4`_ - ---- - -### `cSpell.numSuggestions` - -Name -: `cSpell.numSuggestions` - -Type -: `number` - -Scope -: resource - -Description -: Controls the number of suggestions shown. - -Default -: _`8`_ - ---- - -### `cSpell.revealIssuesAfterDelayMS` - -Name -: `cSpell.revealIssuesAfterDelayMS` -- Reveal Issues After a Delay in Milliseconds - -Type -: `number` - -Scope -: machine - -Description -: Reveal hidden issues related to `#cSpell.hideIssuesWhileTyping#` after a delay in milliseconds. - -Default -: _`1500`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.showAutocompleteDirectiveSuggestions` - -Name -: `cSpell.showAutocompleteDirectiveSuggestions` - -Type -: `boolean` - -Scope -: language-overridable - -Description -: Show CSpell in-document directives as you type. - - **Note:** VS Code must be restarted for this setting to take effect. - -Default -: _`true`_ - ---- - -### `cSpell.showCommandsInEditorContextMenu` - -Name -: `cSpell.showCommandsInEditorContextMenu` - -Type -: `boolean` - -Scope -: application - -Description -: Show Spell Checker actions in Editor Context Menu - -Default -: _`true`_ - ---- - -### `cSpell.showStatus` - -Name -: `cSpell.showStatus` - -Type -: `boolean` - -Scope -: application - -Description -: Display the spell checker status on the status bar. - -Default -: _`true`_ - ---- - -### `cSpell.showStatusAlignment` - -Name -: `cSpell.showStatusAlignment` - - -Type -: `( "Left" | "Right" )` - - | `Left` | Left Side of Statusbar | - | `Right` | Right Side of Statusbar | - - - -Scope -: application - -Description -: The side of the status bar to display the spell checker status. - -Default -: _`"Right"`_ - ---- - -### `cSpell.showSuggestionsLinkInEditorContextMenu` - -Name -: `cSpell.showSuggestionsLinkInEditorContextMenu` - -Type -: `boolean` - -Scope -: application - -Description -: Show Spelling Suggestions link in the top level context menu. - -Default -: _`true`_ - ---- - -### `cSpell.suggestionMenuType` - -Name -: `cSpell.suggestionMenuType` - - -Type -: `( "quickPick" | "quickFix" )` - - | `quickPick` | Suggestions will appear as a drop down at the top of the IDE. (Best choice for Vim Key Bindings) | - | `quickFix` | Suggestions will appear inline near the word, inside the text editor. | - - - -Scope -: resource - -Description -: The type of menu used to display spelling suggestions. - -Default -: _`"quickPick"`_ - ---- - -### `cSpell.suggestionNumChanges` - -Name -: `cSpell.suggestionNumChanges` - -Type -: `number` - -Scope -: resource - -Description -: The maximum number of changes allowed on a word to be considered a suggestions. - - For example, appending an `s` onto `example` -> `examples` is considered 1 change. - - Range: between 1 and 5. - -Default -: _`3`_ - ---- - -### `cSpell.validateDirectives` - -Name -: `cSpell.validateDirectives` - -Type -: `boolean` - -Scope -: window - -Description -: Verify that the in-document directives are correct. - -Default -: _- none -_ - ---- - -# Files, Folders, and Workspaces - -| Setting | Scope | Description | -| ---------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | -| [`cSpell.checkOnlyEnabledFileTypes`](#cspellcheckonlyenabledfiletypes) | resource | Check Only Enabled File Types | -| [`cSpell.enabledFileTypes`](#cspellenabledfiletypes) | resource | Enabled File Types to Check | -| [`cSpell.enabledSchemes`](#cspellenabledschemes) | window | Specify Allowed Schemes | -| [`cSpell.files`](#cspellfiles) | resource | Glob patterns of files to be checked. Glob patterns are relative to the `#cSpell.globRoot#`… | -| [`cSpell.globRoot`](#cspellglobroot) | resource | The root to use for glob patterns found in this configuration. Default: The current workspace… | -| [`cSpell.ignorePaths`](#cspellignorepaths) | resource | Glob patterns of files to be ignored | -| [`cSpell.import`](#cspellimport) | resource | Allows this configuration to inherit configuration for one or more other files. | -| [`cSpell.mergeCSpellSettings`](#cspellmergecspellsettings) | resource | Specify if fields from `.vscode/settings.json` are passed to the spell checker. This only applies… | -| [`cSpell.mergeCSpellSettingsFields`](#cspellmergecspellsettingsfields) | resource | Specify which fields from `.vscode/settings.json` are passed to the spell checker. This only… | -| [`cSpell.noConfigSearch`](#cspellnoconfigsearch) | resource | Prevents searching for local configuration when checking individual documents. | -| [`cSpell.spellCheckOnlyWorkspaceFiles`](#cspellspellcheckonlyworkspacefiles) | window | Spell Check Only Workspace Files | -| [`cSpell.useGitignore`](#cspellusegitignore) | resource | Tells the spell checker to load `.gitignore` files and skip files that match the globs in the… | -| [`cSpell.usePnP`](#cspellusepnp) | resource | Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in… | -| [`cSpell.workspaceRootPath`](#cspellworkspacerootpath) | resource | Workspace Root Folder Path | - -## Definitions - -### ~~`cSpell.allowedSchemas`~~ - -Name -: ~~`cSpell.allowedSchemas`~~ -- Define Allowed Schemes - -Type -: `string[]` - -Scope -: window - -Description -: Control which file schemes will be checked for spelling (VS Code must be restarted for this setting to take effect). - - Some schemes have special meaning like: - - `untitled` - Used for new documents that have not yet been saved - - `vscode-notebook-cell` - Used for validating segments of a Notebook. - - `vscode-userdata` - Needed to spell check `.code-snippets` - - `vscode-scm` - Needed to spell check Source Control commit messages. - - `comment` - Used for new comment editors. - -Deprecation Message -: - Use `#cSpell.enabledSchemes#` instead. - -Default -: _- none -_ - ---- - -### `cSpell.checkOnlyEnabledFileTypes` - -Name -: `cSpell.checkOnlyEnabledFileTypes` -- Check Only Enabled File Types - -Type -: `boolean` - -Scope -: resource - -Description -: By default, the spell checker checks only enabled file types. Use `#cSpell.enableFiletypes#` -to turn on / off various file types. - - When this setting is `false`, all file types are checked except for the ones disabled by `#cSpell.enabledFileTypes#`. - See `#cSpell.enableFiletypes#` on how to disable a file type. - -Default -: _`true`_ - ---- - -### `cSpell.enabledFileTypes` - -Name -: `cSpell.enabledFileTypes` -- Enabled File Types to Check - -Type -: `object` - -Scope -: resource - -Description -: Enable / Disable checking file types (languageIds). - - This setting replaces: `#cSpell.enabledLanguageIds#` and `#cSpell.enableFiletypes#`. - - A Value of: - - `true` - enable checking for the file type - - `false` - disable checking for the file type - - A file type of `*` is a wildcard that enables all file types. - - **Example: enable all file types** - - | File Type | Enabled | Comment | - | --------- | ------- | ------- | - | `*` | `true` | Enable all file types. | - | `json` | `false` | Disable checking for json files. | - - -Default -: code - ```js - { - "asciidoc": true, "bat": true, "c": true, "clojure": true, "coffeescript": - true, "cpp": true, "csharp": true, "css": true, "dart": true, "diff": true, - "dockerfile": true, "elixir": true, "erlang": true, "fsharp": true, - "git-commit": true, "git-rebase": true, "github-actions-workflow": true, "go": - true, "graphql": true, "groovy": true, "handlebars": true, "haskell": true, - "html": true, "ini": true, "jade": true, "java": true, "javascript": true, - "javascriptreact": true, "json": true, "jsonc": true, "julia": true, "jupyter": - true, "latex": true, "less": true, "lua": true, "makefile": true, "markdown": - true, "objective-c": true, "perl": true, "perl6": true, "php": true, - "plaintext": true, "powershell": true, "properties": true, "pug": true, - "python": true, "r": true, "razor": true, "restructuredtext": true, "ruby": - true, "rust": true, "scala": true, "scminput": true, "scss": true, "shaderlab": - true, "shellscript": true, "sql": true, "swift": true, "text": true, - "typescript": true, "typescriptreact": true, "vb": true, "vue": true, "xml": - true, "xsl": true, "yaml": true - } - ``` - - - ---- - -### `cSpell.enabledSchemes` - -Name -: `cSpell.enabledSchemes` -- Specify Allowed Schemes - -Type -: `object` - -Scope -: window - -Description -: Control which file schemes will be checked for spelling (VS Code must be restarted for this setting to take effect). - - Some schemes have special meaning like: - - `untitled` - Used for new documents that have not yet been saved - - `vscode-notebook-cell` - Used for validating segments of a Notebook. - - `vscode-userdata` - Needed to spell check `.code-snippets` - - `vscode-scm` - Needed to spell check Source Control commit messages. - - `comment` - Used for new comment editors. - - -Default -: code - ```js - { - "comment": true, "file": true, "gist": true, "repo": true, "sftp": true, - "untitled": true, "vscode-notebook-cell": true, "vscode-scm": true, - "vscode-userdata": true, "vscode-vfs": true, "vsls": true - } - ``` - - - ---- - -### ~~`cSpell.enableFiletypes`~~ - -Name -: ~~`cSpell.enableFiletypes`~~ -- Enable File Types - -Type -: `string[]` - -Scope -: resource - -Description -: Enable / Disable checking file types (languageIds). - - These are in additional to the file types specified by `#cSpell.enabledLanguageIds#`. - To disable a language, prefix with `!` as in `!json`, - - - **Example: individual file types** - - ``` - jsonc // enable checking for jsonc - !json // disable checking for json - kotlin // enable checking for kotlin - ``` - - **Example: enable all file types** - - ``` - * // enable checking for all file types - !json // except for json - ``` - -Deprecation Message -: - Use `#cSpell.enabledFileTypes#` instead. - -Default -: _- none -_ - ---- - -### `cSpell.files` - -Name -: `cSpell.files` - -Type -: `string[]` - -Scope -: resource - -Description -: Glob patterns of files to be checked. -Glob patterns are relative to the `#cSpell.globRoot#` of the configuration file that defines them. - -Default -: _- none -_ - ---- - -### `cSpell.globRoot` - -Name -: `cSpell.globRoot` - -Type -: `string` - -Scope -: resource - -Description -: The root to use for glob patterns found in this configuration. -Default: The current workspace folder. -Use `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. -Defining globRoot, does not impact imported configurations. - - Special Values: - - - `${workspaceFolder}` - Default - globs will be relative to the current workspace folder - - `${workspaceFolder:}` - Where `` is the name of the workspace folder. - -Default -: _- none -_ - ---- - -### `cSpell.ignorePaths` - -Name -: `cSpell.ignorePaths` -- Glob patterns of files to be ignored - -Type -: `string[]` - -Scope -: resource - -Description -: Glob patterns of files to be ignored. The patterns are relative to the `#cSpell.globRoot#` of the configuration file that defines them. - - -Default -: code - ```js - [ - "package-lock.json", "node_modules", "vscode-extension", - ".git/{info,lfs,logs,refs,objects}/**", ".git/{index,*refs,*HEAD}", ".vscode", - ".vscode-insiders" - ] - ``` - - - ---- - -### `cSpell.import` - -Name -: `cSpell.import` - -Type -: `string[]` - -Scope -: resource - -Description -: Allows this configuration to inherit configuration for one or more other files. - - See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details. - -Default -: _- none -_ - ---- - -### `cSpell.mergeCSpellSettings` - -Name -: `cSpell.mergeCSpellSettings` - -Type -: `boolean` - -Scope -: resource - -Description -: Specify if fields from `.vscode/settings.json` are passed to the spell checker. -This only applies when there is a CSpell configuration file in the workspace. - - The purpose of this setting to help provide a consistent result compared to the - CSpell spell checker command line tool. - - Values: - - `true` - all settings will be merged based upon `#cSpell.mergeCSpellSettingsFields#`. - - `false` - only use `.vscode/settings.json` if a CSpell configuration is not found. - - Note: this setting is used in conjunction with `#cSpell.mergeCSpellSettingsFields#`. - -Default -: _`true`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.mergeCSpellSettingsFields` - -Name -: `cSpell.mergeCSpellSettingsFields` - -Type -: `object` - -Scope -: resource - -Description -: Specify which fields from `.vscode/settings.json` are passed to the spell checker. -This only applies when there is a CSpell configuration file in the workspace and -`#cSpell.mergeCSpellSettings#` is `true`. - - Values: - - `{ flagWords: true, userWords: false }` - Always allow `flagWords`, but never allow `userWords`. - - Example: - ```jsonc - "cSpell.mergeCSpellSettingsFields": { "userWords": false } - ``` - - -Default -: code - ```js - { - "allowCompoundWords": true, "caseSensitive": true, "dictionaries": true, - "dictionaryDefinitions": true, "enableGlobDot": true, "features": true, - "files": true, "flagWords": true, "gitignoreRoot": true, "globRoot": true, - "ignorePaths": true, "ignoreRegExpList": true, "ignoreWords": true, "import": - true, "includeRegExpList": true, "language": true, "languageId": true, - "languageSettings": true, "loadDefaultConfiguration": true, "minWordLength": - true, "noConfigSearch": true, "noSuggestDictionaries": true, "numSuggestions": - true, "overrides": true, "patterns": true, "pnpFiles": true, "reporters": true, - "suggestWords": true, "useGitignore": true, "usePnP": true, "userWords": true, - "validateDirectives": true, "words": true - } - ``` - - - -Since Version -: 4.0.0 - ---- - -### `cSpell.noConfigSearch` - -Name -: `cSpell.noConfigSearch` - -Type -: `boolean` - -Scope -: resource - -Description -: Prevents searching for local configuration when checking individual documents. - -Default -: _- none -_ - ---- - -### `cSpell.spellCheckOnlyWorkspaceFiles` - -Name -: `cSpell.spellCheckOnlyWorkspaceFiles` -- Spell Check Only Workspace Files - -Type -: `boolean` - -Scope -: window - -Description -: Only spell check files that are in the currently open workspace. -This same effect can be achieved using the `#cSpell.files#` setting. - - ```js - "cSpell.files": ["/**"] - ``` - -Default -: _`false`_ - ---- - -### `cSpell.useGitignore` - -Name -: `cSpell.useGitignore` - -Type -: `boolean` - -Scope -: resource - -Description -: Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. - -Default -: _`true`_ - ---- - -### `cSpell.usePnP` - -Name -: `cSpell.usePnP` - -Type -: `boolean` - -Scope -: resource - -Description -: Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading -packages stored in the repository. - - When true, the spell checker will search up the directory structure for the existence - of a PnP file and load it. - -Default -: _- none -_ - ---- - -### `cSpell.workspaceRootPath` - -Name -: `cSpell.workspaceRootPath` -- Workspace Root Folder Path - -Type -: `string` - -Scope -: resource - -Description -: Define the path to the workspace root folder in a multi-root workspace. -By default it is the first folder. - - This is used to find the `cspell.json` file for the workspace. - - - **Example: use the `client` folder** - ``` - ${workspaceFolder:client} - ``` - -Default -: _- none -_ - ---- - -# Performance - -| Setting | Scope | Description | -| ------------------------------------------------------------------------------------------------------------ | -------------------- | -------------------------------------------------------------------------------- | -| [`cSpell.blockCheckingWhenAverageChunkSizeGreaterThan`](#cspellblockcheckingwhenaveragechunksizegreaterthan) | language-overridable | The maximum average length of chunks of text without word breaks. | -| [`cSpell.blockCheckingWhenLineLengthGreaterThan`](#cspellblockcheckingwhenlinelengthgreaterthan) | language-overridable | The maximum line length. | -| [`cSpell.blockCheckingWhenTextChunkSizeGreaterThan`](#cspellblockcheckingwhentextchunksizegreaterthan) | language-overridable | The maximum length of a chunk of text without word breaks. | -| [`cSpell.checkLimit`](#cspellchecklimit) | resource | Set the maximum number of bocks of text to check. Each block is 1024 characters. | -| [`cSpell.spellCheckDelayMs`](#cspellspellcheckdelayms) | application | Delay in ms after a document has changed before checking it for spelling errors. | -| [`cSpell.suggestionsTimeout`](#cspellsuggestionstimeout) | resource | The maximum amount of time in milliseconds to generate suggestions for a word. | - -## Definitions - -### `cSpell.blockCheckingWhenAverageChunkSizeGreaterThan` - -Name -: `cSpell.blockCheckingWhenAverageChunkSizeGreaterThan` - -Type -: `number` - -Scope -: language-overridable - -Description -: The maximum average length of chunks of text without word breaks. - - A chunk is the characters between absolute word breaks. - Absolute word breaks match: `/[\s,{}[\]]/` - - - **Error Message:** _Average Word Size is Too High._ - - - If you are seeing this message, it means that the file contains mostly long lines - without many word breaks. - -Default -: _`80`_ - ---- - -### `cSpell.blockCheckingWhenLineLengthGreaterThan` - -Name -: `cSpell.blockCheckingWhenLineLengthGreaterThan` - -Type -: `number` - -Scope -: language-overridable - -Description -: The maximum line length. - - Block spell checking if lines are longer than the value given. - This is used to prevent spell checking generated files. - - - **Error Message:** _Lines are too long._ - -Default -: _`10000`_ - ---- - -### `cSpell.blockCheckingWhenTextChunkSizeGreaterThan` - -Name -: `cSpell.blockCheckingWhenTextChunkSizeGreaterThan` - -Type -: `number` - -Scope -: language-overridable - -Description -: The maximum length of a chunk of text without word breaks. - - It is used to prevent spell checking of generated files. - - - A chunk is the characters between absolute word breaks. - Absolute word breaks match: `/[\s,{}[\]]/`, i.e. spaces or braces. - - - **Error Message:** _Maximum Word Length is Too High._ - - - If you are seeing this message, it means that the file contains a very long line - without many word breaks. - -Default -: _`500`_ - ---- - -### `cSpell.checkLimit` - -Name -: `cSpell.checkLimit` - -Type -: `number` - -Scope -: resource - -Description -: Set the maximum number of bocks of text to check. -Each block is 1024 characters. - -Default -: _`500`_ - ---- - -### `cSpell.spellCheckDelayMs` - -Name -: `cSpell.spellCheckDelayMs` - -Type -: `number` - -Scope -: application - -Description -: Delay in ms after a document has changed before checking it for spelling errors. - -Default -: _`50`_ - ---- - -### `cSpell.suggestionsTimeout` - -Name -: `cSpell.suggestionsTimeout` - -Type -: `number` - -Scope -: resource - -Description -: The maximum amount of time in milliseconds to generate suggestions for a word. - -Default -: _`400`_ - ---- - -# CSpell - -| Setting | Scope | Description | -| ---------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -| [`cSpell.ignoreRegExpList`](#cspellignoreregexplist) | resource | List of regular expressions or Pattern names (defined in `#cSpell.patterns#`) to exclude from… | -| [`cSpell.includeRegExpList`](#cspellincluderegexplist) | resource | List of regular expression patterns or defined pattern names to match for spell checking. | -| [`cSpell.languageStatusFields`](#cspelllanguagestatusfields) | machine | Select which fields to display in the language status bar. | -| [`cSpell.overrides`](#cspelloverrides) | resource | Overrides are used to apply settings for specific files in your project. | -| [`cSpell.patterns`](#cspellpatterns) | resource | Defines a list of patterns that can be used with the `#cSpell.ignoreRegExpList#` and `#cSpell.includeRegExpList#`… | -| [`cSpell.useLocallyInstalledCSpellDictionaries`](#cspelluselocallyinstalledcspelldictionaries) | resource | Search for `@cspell/cspell-bundled-dicts` in the workspace folder and use it if found. | - -## Definitions - -### `cSpell.ignoreRegExpList` - -Name -: `cSpell.ignoreRegExpList` - -Type -: `string[]` - -Scope -: resource - -Description -: List of regular expressions or Pattern names (defined in `#cSpell.patterns#`) to exclude from spell checking. - - - When using the VS Code Preferences UI, it is not necessary to escape the `\`, VS Code takes care of that. - - When editing the VS Code `settings.json` file, - it is necessary to escape `\`. - Each `\` becomes `\\`. - - The default regular expression flags are `gi`. Add `u` (`gui`), to enable Unicode. - - | VS Code UI | settings.json | Description | - | :------------------ | :-------------------- | :------------------------------------------- | - | `/\\[a-z]+/gi` | `/\\\\[a-z]+/gi` | Exclude LaTeX command like `\mapsto` | - | `/\b[A-Z]{3,5}\b/g` | `/\\b[A-Z]{3,5}\\b/g` | Exclude full-caps acronyms of 3-5 length. | - | `CStyleComment` | `CStyleComment` | A built in pattern | - -Default -: _- none -_ - ---- - -### `cSpell.includeRegExpList` - -Name -: `cSpell.includeRegExpList` - -Type -: `string[]` - -Scope -: resource - -Description -: List of regular expression patterns or defined pattern names to match for spell checking. - - If this property is defined, only text matching the included patterns will be checked. - -Default -: _- none -_ - ---- - -### `cSpell.languageStatusFields` - -Name -: `cSpell.languageStatusFields` - -Type -: `object` - -Scope -: machine - -Description -: Select which fields to display in the language status bar. - -Default -: _`{"fileType":true,"issues":true,"scheme":true}`_ - ---- - -### `cSpell.overrides` - -Name -: `cSpell.overrides` - -Type -: `object[]` - -Scope -: resource - -Description -: Overrides are used to apply settings for specific files in your project. - - **Example:** - - ```jsonc - "cSpell.overrides": [ - // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: - { - "filename": "**/{*.hrr,*.crr}", - "languageId": "cpp" - }, - // Force `dutch/**/*.txt` to be treated as Dutch (dictionary needs to be installed separately): - { - "filename": "**/dutch/**/*.txt", - "language": "nl" - } - ] - ``` - -Default -: _- none -_ - ---- - -### `cSpell.patterns` - -Name -: `cSpell.patterns` - -Type -: `object[]` - -Scope -: resource - -Description -: Defines a list of patterns that can be used with the `#cSpell.ignoreRegExpList#` and -`#cSpell.includeRegExpList#` options. - - **Example:** - - ```jsonc - "cSpell.patterns": [ - { - "name": "comment-single-line", - "pattern": "/#.*/g" - }, - { - "name": "comment-multi-line", - "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" - } - ] - ``` - -Default -: _- none -_ - ---- - -### `cSpell.useLocallyInstalledCSpellDictionaries` - -Name -: `cSpell.useLocallyInstalledCSpellDictionaries` - -Type -: `boolean` - -Scope -: resource - -Description -: Search for `@cspell/cspell-bundled-dicts` in the workspace folder and use it if found. - -Default -: _`true`_ - -Since Version -: 4.0.0 - ---- - -# Appearance - -| Setting | Scope | Description | -| -------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------- | -| [`cSpell.dark`](#cspelldark) | machine | Decoration for dark themes. | -| [`cSpell.doNotUseCustomDecorationForScheme`](#cspelldonotusecustomdecorationforscheme) | machine | Use VS Code to Render Spelling Issues | -| [`cSpell.light`](#cspelllight) | machine | Decoration for light themes. | -| [`cSpell.overviewRulerColor`](#cspelloverviewrulercolor) | machine | The CSS color used to show issues in the ruler. | -| [`cSpell.textDecoration`](#cspelltextdecoration) | machine | The CSS Style used to decorate spelling issues. Depends upon `#cSpell.useCustomDecorations#`. | -| [`cSpell.textDecorationColor`](#cspelltextdecorationcolor) | machine | The decoration color for normal spelling issues. | -| [`cSpell.textDecorationColorFlagged`](#cspelltextdecorationcolorflagged) | machine | The decoration color for flagged issues. | -| [`cSpell.textDecorationLine`](#cspelltextdecorationline) | machine | The CSS line type used to decorate issues. | -| [`cSpell.textDecorationStyle`](#cspelltextdecorationstyle) | machine | The CSS line style used to decorate issues. | -| [`cSpell.textDecorationThickness`](#cspelltextdecorationthickness) | machine | The CSS line thickness used to decorate issues. | -| [`cSpell.useCustomDecorations`](#cspellusecustomdecorations) | machine | Draw custom decorations on Spelling Issues. | - -## Definitions - -### `cSpell.dark` - -Name -: `cSpell.dark` - -Type -: `object` - -Scope -: machine - -Description -: Decoration for dark themes. - - See: - - `#cSpell.overviewRulerColor#` - - `#cSpell.textDecoration#` - -Default -: _- none -_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.doNotUseCustomDecorationForScheme` - -Name -: `cSpell.doNotUseCustomDecorationForScheme` -- Use VS Code to Render Spelling Issues - -Type -: `object` - -Scope -: machine - -Description -: Use the VS Code Diagnostic Collection to render spelling issues. - - With some edit boxes, like the source control message box, the custom decorations do not show up. - This setting allows the use of the VS Code Diagnostic Collection to render spelling issues. - -Default -: _`{"vscode-scm":true}`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.light` - -Name -: `cSpell.light` - -Type -: `object` - -Scope -: machine - -Description -: Decoration for light themes. - - See: - - `#cSpell.overviewRulerColor#` - - `#cSpell.textDecoration#` - -Default -: _- none -_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.overviewRulerColor` - -Name -: `cSpell.overviewRulerColor` - -Type -: `string` - -Scope -: machine - -Description -: The CSS color used to show issues in the ruler. - - See: - - [`` CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) - - [CSS Colors, W3C Schools](https://www.w3schools.com/cssref/css_colors.php) - - Hex colors - - Use "" (empty string) to disable. - - Examples: - - `green` - - `DarkYellow` - - `#ffff0080` - semi-transparent yellow. - - `rgb(255 153 0 / 80%)` - -Default -: _`"#fc4c"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecoration` - -Name -: `cSpell.textDecoration` - -Type -: `string` - -Scope -: machine - -Description -: The CSS Style used to decorate spelling issues. Depends upon `#cSpell.useCustomDecorations#`. - - This setting is used to manually configure the text decoration. If it is not set, the following settings are used: - - `#cSpell.textDecorationLine#` to pick the line type - - `#cSpell.textDecorationStyle#` to pick the style - - `#cSpell.textDecorationColor#` to set the color - - `#cSpell.textDecorationThickness#` to set the thickness. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - Format: ` [style] [thickness]` - - - line - `underline`, `overline`, see: [text-decoration-line, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-line) - - style - `solid`, `wavy`, `dotted`, see: [text-decoration-style, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-style) - - color - see: [text-decoration-color, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-color) - - thickness - see: [text-decoration-thickness, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-thickness) - - Examples: - - `underline green` - - `underline dotted yellow 0.2rem` - - `underline wavy #ff0c 1.5px` - Wavy underline with 1.5px thickness in semi-transparent yellow. - -Default -: _- none -_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecorationColor` - -Name -: `cSpell.textDecorationColor` - -Type -: `string` - -Scope -: machine - -Description -: The decoration color for normal spelling issues. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - color - see: [text-decoration-color, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-color) - - Examples: - - `green` - - `yellow` - - `#ff0c` - -Default -: _`"#fc4"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecorationColorFlagged` - -Name -: `cSpell.textDecorationColorFlagged` - -Type -: `string` - -Scope -: machine - -Description -: The decoration color for flagged issues. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - color - see: [text-decoration-color, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-color) - - Examples: - - `green` - - `yellow` - - `#ff0c` - -Default -: _`"#f44"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecorationLine` - -Name -: `cSpell.textDecorationLine` - -Type -: `( "underline" | "overline" | "line-through" )` - -Scope -: machine - -Description -: The CSS line type used to decorate issues. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - line - `underline`, `overline`, see: [text-decoration-line, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-line) - -Default -: _`"underline"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecorationStyle` - -Name -: `cSpell.textDecorationStyle` - -Type -: `( "solid" | "wavy" | "dotted" | "dashed" | "double" )` - -Scope -: machine - -Description -: The CSS line style used to decorate issues. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - style - `solid`, `wavy`, `dotted`, see: [text-decoration-style, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-style) - -Default -: _`"wavy"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.textDecorationThickness` - -Name -: `cSpell.textDecorationThickness` - -Type -: `string` - -Scope -: machine - -Description -: The CSS line thickness used to decorate issues. - - See: [text-decoration - CSS: Cascading Style Sheets, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) - - thickness - see: [text-decoration-thickness, MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-thickness) - - Examples: - - `auto` - - `from-font` - - `0.2rem` - - `1.5px` - - `10%` - -Default -: _`"auto"`_ - -Since Version -: 4.0.0 - ---- - -### `cSpell.useCustomDecorations` - -Name -: `cSpell.useCustomDecorations` - -Type -: `boolean` - -Scope -: machine - -Description -: Draw custom decorations on Spelling Issues. - -Default -: _`true`_ - -Since Version -: 4.0.0 - ---- - -# Advanced - -| Setting | Scope | Description | -| ---------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------------------------- | -| [`cSpell.advanced.feature.useReferenceProviderRemove`](#cspelladvancedfeatureusereferenceproviderremove) | language-overridable | Remove Matching Characters Before Rename | -| [`cSpell.advanced.feature.useReferenceProviderWithRename`](#cspelladvancedfeatureusereferenceproviderwithrename) | language-overridable | Use Reference Provider During Rename | -| [`cSpell.fixSpellingWithRenameProvider`](#cspellfixspellingwithrenameprovider) | language-overridable | Use Rename Provider when fixing spelling issues. | -| [`cSpell.logFile`](#cspelllogfile) | window | Write Logs to a File | -| [`cSpell.logLevel`](#cspellloglevel) | window | Set Logging Level | -| [`cSpell.trustedWorkspace`](#cspelltrustedworkspace) | window | Enable loading JavaScript CSpell configuration files. | - -## Definitions - -### `cSpell.advanced.feature.useReferenceProviderRemove` - -Name -: `cSpell.advanced.feature.useReferenceProviderRemove` -- Remove Matching Characters Before Rename - -Type -: `string` - -Scope -: language-overridable - -Description -: Used to work around bugs in Reference Providers and Rename Providers. -Anything matching the provided Regular Expression will be removed from the text -before sending it to the Rename Provider. - - See: [Markdown: Fixing spelling issues in Header sections changes the entire line · Issue #1987](https://github.com/streetsidesoftware/vscode-spell-checker/issues/1987) - - It is unlikely that you would need to edit this setting. If you need to, please open an issue at - [Spell Checker Issues](https://github.com/streetsidesoftware/vscode-spell-checker/issues) - - This feature is used in connection with `#cSpell.advanced.feature.useReferenceProviderWithRename#` - -Default -: _- none -_ - ---- - -### `cSpell.advanced.feature.useReferenceProviderWithRename` - -Name -: `cSpell.advanced.feature.useReferenceProviderWithRename` -- Use Reference Provider During Rename - -Type -: `boolean` - -Scope -: language-overridable - -Description -: Use the Reference Provider when fixing spelling issues with the Rename Provider. -This feature is used in connection with `#cSpell.fixSpellingWithRenameProvider#` - -Default -: _`false`_ - ---- - -### `cSpell.fixSpellingWithRenameProvider` - -Name -: `cSpell.fixSpellingWithRenameProvider` - -Type -: `boolean` - -Scope -: language-overridable - -Description -: Use Rename Provider when fixing spelling issues. - -Default -: _`true`_ - ---- - -### `cSpell.logFile` - -Name -: `cSpell.logFile` -- Write Logs to a File - -Type -: `string` - -Scope -: window - -Description -: Have the logs written to a file instead of to VS Code. - -Default -: _- none -_ - ---- - -### `cSpell.logLevel` - -Name -: `cSpell.logLevel` -- Set Logging Level - - -Type -: `( "None" | "Error" | "Warning" | "Information" | "Debug" )` - - | `None` | Do not log | - | `Error` | Log only errors | - | `Warning` | Log errors and warnings | - | `Information` | Log errors, warnings, and info | - | `Debug` | Log everything (noisy) | - - - -Scope -: window - -Description -: Set the Debug Level for logging messages. - -Default -: _`"Error"`_ - ---- - -### `cSpell.trustedWorkspace` - -Name -: `cSpell.trustedWorkspace` - -Type -: `boolean` - -Scope -: window - -Description -: Enable loading JavaScript CSpell configuration files. - - This setting is automatically set to `true` in a trusted workspace. It is possible to override the setting to `false` in a trusted workspace, - but a setting of `true` in an untrusted workspace will be ignored. - - See: - - [Visual Studio Code Workspace Trust security](https://code.visualstudio.com/docs/editor/workspace-trust) - - [Workspace Trust Extension Guide -- Visual Studio Code Extension API](https://code.visualstudio.com/api/extension-guides/workspace-trust) - -Default -: _`true`_ - -Since Version -: 4.0.0 - ---- - -# Experimental - -| Setting | Scope | Description | -| ----------------------------------------------------------------------------------------- | ----------- | --------------------------------------- | -| [`cSpell.experimental.enableRegexpView`](#cspellexperimentalenableregexpview) | application | Show Regular Expression Explorer | -| [`cSpell.experimental.enableSettingsViewerV2`](#cspellexperimentalenablesettingsviewerv2) | application | Enable the Settings Viewer V2 Extension | - -## Definitions - -### `cSpell.experimental.enableRegexpView` - -Name -: `cSpell.experimental.enableRegexpView` - -Type -: `boolean` - -Scope -: application - -Description -: Show Regular Expression Explorer - -Default -: _`false`_ - ---- - -### `cSpell.experimental.enableSettingsViewerV2` - -Name -: `cSpell.experimental.enableSettingsViewerV2` - -Type -: `boolean` - -Scope -: application - -Description -: Enable the Settings Viewer V2 Extension - -Default -: _`false`_ - ---- - -# Legacy - -| Setting | Scope | Description | -| -------------------------------------------------------- | -------- | ----------------------------------------- | -| [`cSpell.allowCompoundWords`](#cspellallowcompoundwords) | resource | Enable / Disable allowing word compounds. | - -## Definitions - -### `cSpell.allowCompoundWords` - -Name -: `cSpell.allowCompoundWords` - -Type -: `boolean` - -Scope -: resource - -Description -: Enable / Disable allowing word compounds. - `true` means `arraylength` would be ok - `false` means it would not pass. - - Note: this can also cause many misspelled words to seem correct. - -Default -: _`false`_ - ---- - -### ~~`cSpell.customFolderDictionaries`~~ - -Name -: ~~`cSpell.customFolderDictionaries`~~ -- Custom Folder Dictionaries - -Type -: `( object | string )[]` - -Scope -: resource - -Description -: Define custom dictionaries to be included by default for the folder. -If `addWords` is `true` words will be added to this dictionary. - -Deprecation Message -: - Use `#cSpell.customDictionaries#` instead. - -Default -: _- none -_ - ---- - -### ~~`cSpell.customUserDictionaries`~~ - -Name -: ~~`cSpell.customUserDictionaries`~~ -- Custom User Dictionaries - -Type -: `( object | string )[]` - -Scope -: application - -Description -: Define custom dictionaries to be included by default for the user. -If `addWords` is `true` words will be added to this dictionary. - -Deprecation Message -: - Use `#cSpell.customDictionaries#` instead. - -Default -: _- none -_ - ---- - -### ~~`cSpell.customWorkspaceDictionaries`~~ - -Name -: ~~`cSpell.customWorkspaceDictionaries`~~ -- Custom Workspace Dictionaries - -Type -: `( object | string )[]` - -Scope -: resource - -Description -: Define custom dictionaries to be included by default for the workspace. -If `addWords` is `true` words will be added to this dictionary. - -Deprecation Message -: - Use `#cSpell.customDictionaries#` instead. - -Default -: _- none -_ - ---- - -### ~~`cSpell.enabledLanguageIds`~~ - -Name -: ~~`cSpell.enabledLanguageIds`~~ -- Enabled Language Ids - -Type -: `string[]` - -Scope -: resource - -Description -: Specify a list of file types to spell check. It is better to use `#cSpell.enabledFileTypes#` to Enable / Disable checking files types. - -Deprecation Message -: - Use `#cSpell.enabledFileTypes#` instead. - -Default -: _- none -_ - ---- diff --git a/docs/_scripts/extract-commands.mjs b/docs/_scripts/extract-commands.mjs deleted file mode 100644 index 9dadcffb4c..0000000000 --- a/docs/_scripts/extract-commands.mjs +++ /dev/null @@ -1,45 +0,0 @@ -import { createRequire } from 'module'; - -const require = createRequire(import.meta.url); - -const pkgJson = require('../../package.json'); - -const commands = pkgJson.contributes.commands; - -const compare = new Intl.Collator().compare; - -const isCSpellCommand = /^cSpell\./; -const entries = Object.values(commands) - .filter((cmd) => isCSpellCommand.test(cmd.command)) - .sort((a, b) => compare(a.command, b.command)); - -const doc = ` - - -# Commands - -${genCommands(entries)} - -`.replace(/\*\u200B/g, '*'); // remove zero width spaces - -console.log(doc); - -function genCommands(entries) { - return ` -| Command | Title | -| ------- | ----- | -${entries.map(commandEntry).join('\n')} -`; -} - -/** - * - * @param {[string, any]} param0 - * @returns - */ -function commandEntry(command) { - const description = [command.title, command.enablement ? `**When:**
\`${command.enablement}\`` : ''] - .filter((a) => a) - .join('
'); - return `| \`${command.command}\` | ${description} |`; -} diff --git a/docs/_scripts/extract-config.mjs b/docs/_scripts/extract-config.mjs deleted file mode 100644 index 391745e4d3..0000000000 --- a/docs/_scripts/extract-config.mjs +++ /dev/null @@ -1,453 +0,0 @@ -// @ts-check -import { promises as fs } from 'node:fs'; - -/** - * JSONSchema4. - * @typedef {import('json-schema').JSONSchema4} JSONSchema4 - */ - -/** - * JSON Schema primitive types - * @typedef {import('json-schema').JSONSchema4Type} JSONSchema4Type - */ - -/** - * @typedef {import('json-schema').JSONSchema4TypeName} JSONSchema4TypeName - */ - -/** - * The Schema File URL - */ -const schemaFile = new URL('../../packages/_server/spell-checker-config.schema.json', import.meta.url); -const descriptionWidth = 90; -const compare = new Intl.Collator().compare; - -async function run() { - const configSections = await loadSchema(); - - if (!Array.isArray(configSections)) { - return; - } - - configSections.sort((a, b) => a.order - b.order || compare(a.title || '', b.title || '')); - - const doc = ` - - -# Configuration Settings - -${sectionTOC(configSections)} - -${formatSections(configSections)} - -`.replace(/\u200B/g, ''); // remove zero width spaces - - console.log(doc); - - /** - * @param {JSONSchema4[]} sections - * @returns - */ - function sectionTOC(sections) { - /** - * - * @param {JSONSchema4} value - * @returns - */ - function tocEntry(value) { - if (!value.title) return ''; - const title = value.title; - return `- [${title}](#${title.toLowerCase().replace(/\W+/g, '-')})`; - } - - return `\n${sections - .map(tocEntry) - .filter((a) => !!a) - .join('\n')}\n`; - } -} - -/** - * - * @param {JSONSchema4[]} sections - * @returns - */ -function formatSections(sections) { - return sections.map(sectionEntry).join('\n'); -} - -/** - * @param {JSONSchema4} section - * @returns - */ -function sectionEntry(section) { - const entries = Object.entries(section.properties || {}); - entries.sort(([a], [b]) => compare(a, b)); - const activeEntries = entries.filter(([, value]) => !value.deprecationMessage); - - return ` -# ${section.title} - -${configTable(activeEntries)} - -## Definitions - -${configDefinitions(entries)} - -`; -} - -/** - * - * @param {[string, JSONSchema4][]} entries - * @returns - */ -function configTable(entries) { - /** - * - * @param {[string, any]} param0 - * @returns - */ - function tableEntryConfig([key, value]) { - const description = - value.title || - value.description?.replace(/\n/g, '
') || - value.markdownDescription?.replace(/\n[\s\S]*/g, ' ') || - ''; - const scope = value.scope || ''; - return `| [\`${shorten(key, 60)}\`](#${key.toLowerCase().replace(/\W/g, '')}) | ${scope} | ${shortenLine( - description, - descriptionWidth, - )} |`; - } - - return ` -| Setting | Scope | Description | -| ------- | ----- | ----------- | -${entries.map(tableEntryConfig).join('\n')} -`; -} - -/** - * - * @param {string} line - * @param {number} len - * @returns - */ -function shortenLine(line, len) { - const lines = line.split('
'); - if (lines.length > 1) return shortenLine(lines[0], len); - if (line.length <= len) return line; - - const isSpace = /\s/; - - let i = len; - while (i < line.length && !isSpace.test(line[i])) { - ++i; - } - return i < line.length ? line.slice(0, i) + '…' : line; -} - -/** - * - * @param {[string, JSONSchema4][]} entries - * @returns - */ -function configDefinitions(entries) { - return entries.map(definition).join('\n'); -} - -/** - * - * @param {[string, JSONSchema4]} entry - * @returns - */ -function definition(entry) { - const [key, value] = entry; - const description = value.markdownDescription || value.description || value.title || ''; - const since = value.since || ''; - const defaultValue = formatDefaultValue(value.default); - - const title = value.title ? `-- ${value.title}` : ''; - let name = '`' + key + '`'; - if (value.deprecationMessage) { - name = '~~' + name + '~~'; - } - - const deprecationMessage = value.deprecationMessage - ? singleDef('Deprecation Message', value.deprecationMessage) - : ''; - - return ` -### ${name} - -${singleDef('Name', `${name} ${title}`)} - -${singleDef('Type', formatType(value), true)} - -${singleDef('Scope', value.scope || '_- none -_')} - -${singleDef('Description', description)} - -${deprecationMessage} - -${singleDef('Default', defaultValue, true)} - -${since ? singleDef('Since Version', since) : ''} - ---- -`; -} - -/** - * - * @param {string} term - * @param {string} def - * @returns - */ -function singleDef(term, def, addIgnore = false) { - const lines = []; - - const defLines = def.replace(/\n/g, '\n '); - const termDef = `${term}\n: ${defLines}`; - const termLines = termDef.split('\n').map((line) => line.trimEnd()); - - if (termLines.length > 2 && addIgnore) { - lines.push(''); - } - - lines.push(...termLines); - - if (termLines.length > 2 && addIgnore) { - lines.push(''); - } - - return lines.join('\n'); -} - -/** - * - * @param {JSONSchema4Type | undefined} value - * @returns {string} - */ -function _formatDefaultValue(value) { - if (value === undefined) return ''; - - if (Array.isArray(value)) { - return '[ ' + value.map(_formatDefaultValue).join(', ') + ' ]'; - } - - return JSON.stringify(value); -} - -/** - * - * @param {JSONSchema4Type | undefined} value - * @returns - */ -function formatDefaultValue(value) { - if (value === undefined) return '_- none -_'; - - const text = beautifyJSON(_formatDefaultValue(value), 80); - const lines = text.split('\n'); - if (lines.length > 1) { - // console.error('%o', lines); - return 'code\n```js\n' + text + '\n```\n'; - } - - return '_`' + text + '`_'; -} - -/** - * - * @param {JSONSchema4 | undefined} def - * @returns {string} - */ -function extractTypeAndFormat(def) { - return formatExtractedType(extractType(def)); -} - -/** - * - * @param {string | string[]} types - */ -function formatExtractedType(types) { - if (!Array.isArray(types)) return types; - if (types.length === 1) return types[0]; - return '( ' + types.join(' | ') + ' )'; -} - -/** - * @param {JSONSchema4 | undefined} def - * @returns {string | string[]} - */ -function extractType(def) { - if (!def) return ''; - if (def.type === 'array') return extractTypeAndFormat(def.items) + '[]'; - - if (def.enum) { - return def.enum.map((v) => JSON.stringify(v)); - } - - if (def.type) return def.type; - - if (Array.isArray(def.anyOf)) { - const types = [...new Set(def.anyOf.map(extractType).flat())]; - if (types.length === 1) return types[0]; - return types; - } - - return ''; -} - -/** - * - * @param {JSONSchema4} def - * @returns {string} - */ -function extractEnumDescriptions(def) { - if (!def.enumDescriptions || !def.enum) return ''; - - const defs = def.enum - .map((e, i) => [e, def.enumDescriptions[i] || '_No description_']) - .map(([e, d]) => `| \`${e}\` | ${d.replace(/\n/g, '
')} |`) - .join('\n'); - - return ` - -${defs} -`; -} - -/** - * - * @param {JSONSchema4} def - * @returns - */ -function formatType(def) { - const typeLines = beautifyType(extractTypeAndFormat(def), 80); - const types = - typeLines.length > 1 ? 'definition\n```\n' + typeLines.join('\n') + '\n```\n' : '`' + typeLines[0] + '`'; - const enumDefs = extractEnumDescriptions(def); - return types + enumDefs; -} - -/** - * - * @param {string} text - * @param {number} len - */ -function shorten(text, len) { - return text.length <= len ? text : text.slice(0, len - 1) + '…'; -} - -/** - * @returns {Promise>} - */ -async function loadSchema() { - const schema = JSON.parse(await fs.readFile(schemaFile, 'utf8')); - - if (schema.items) return schema.items; - return { - properties: schema.properties, - }; -} - -/** - * @param {string} json - * @param {number} width - * @returns {string} - */ -function beautifyJSON(json, width) { - if (json.length < width) return json; - - const lines = []; - let line = ''; - - /** - * - * @param {...string} items - * @returns {void} - */ - function addToLine(...items) { - for (const text of items) { - if (text === '\n') { - lines.push(line); - line = ''; - continue; - } - if (line.length + text.length > width) { - if (line) lines.push(line); - line = ''; - } - line += text; - } - } - - const obj = JSON.parse(json); - if (typeof obj !== 'object') return json; - if (Array.isArray(obj)) { - addToLine('[', '\n'); - obj.forEach((item, index) => { - addToLine(JSON.stringify(item) + (index === obj.length - 1 ? '' : ', ')); - }); - addToLine('\n', ']'); - } else if (typeof obj === 'object') { - addToLine('{', '\n'); - const entries = Object.entries(obj); - entries.forEach(([key, item], index) => { - addToLine(JSON.stringify(key) + ': ', JSON.stringify(item) + (index === entries.length - 1 ? '' : ', ')); - }); - addToLine('\n', '}'); - } - - if (line) lines.push(line); - - // console.error('%o', lines); - - return lines.join('\n'); -} - -/** - * @param {string} dataType - * @param {number} width - * @returns {string[]} - */ -function beautifyType(dataType, width) { - if (dataType.length < width) return [dataType]; - - const lines = []; - let line = ''; - - /** - * - * @param {...string} items - * @returns {void} - */ - function addToLine(...items) { - for (const text of items) { - if (text === '\n') { - lines.push(line); - line = ''; - continue; - } - if (line.length + text.length > width) { - if (line) lines.push(line); - line = ''; - } - line += text; - } - } - - const items = dataType.split('|'); - const fixed = items.map((item, index) => item + (index === items.length - 1 ? '' : ' |')); - - addToLine(...fixed); - if (line) lines.push(line); - - // console.error('%o', lines); - - return lines; -} - -run(); diff --git a/docs/_scripts/jsconfig.json b/docs/_scripts/jsconfig.json deleted file mode 100644 index 2039760629..0000000000 --- a/docs/_scripts/jsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "compilerOptions": { - "module": "NodeNext", - "target": "ES2022", - "types": ["node", "json-schema"] - }, - "exclude": ["node_modules"] -} diff --git a/docs/_scripts/package.json b/docs/_scripts/package.json deleted file mode 100644 index 5e20c92318..0000000000 --- a/docs/_scripts/package.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "name": "docs_scripts", - "type": "module", - "engines": { - "node": ">=20" - }, - "scripts": {}, - "devDependencies": { - "@types/json-schema": "^7.0.15" - } -} diff --git a/docs/about.md b/docs/about.md deleted file mode 100644 index 07f7ac5ac4..0000000000 --- a/docs/about.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: About -nav_order: 9 -permalink: /about/ ---- - -# About - -When we started using VS Code, it did not have a spell checker. As a person that has trouble with spelling, I found this to be a great hindrance, thus the extension was born. -At the suggestion of users, [`cspell`](https://github.com/streetsidesoftware/cspell) was pulled out of the extension and into its own library and command line tools. - -## Goals - -The goal was to have a fast spell checker that could check spelling as you type. - -- Fast - check as you type -- Self-contained - a pure JS implementation - does not need external binaries or to talk to a web service. -- Compact - the size of the spell checker should not be much bigger than the comparable Hunspell dictionary. -- Configurable - much of CSpell is configured through `cspell.json` files. -- Custom Dictionaries - custom dictionaries can be easily added and used. - -## Supporting Development - -- Become a [![Patreon](./assets/images/patreon/Digital-Patreon-Logo_FieryCoral_16x16.png) Patreon!](https://patreon.com/streetsidesoftware) -- Support through [![PayPal](./assets/images/PayPal/paypal-logo-wide-18.png)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) - - diff --git a/docs/assets/images/PayPal/paypal-logo-wide-16.png b/docs/assets/images/PayPal/paypal-logo-wide-16.png deleted file mode 100644 index c125f5d1f2..0000000000 Binary files a/docs/assets/images/PayPal/paypal-logo-wide-16.png and /dev/null differ diff --git a/docs/assets/images/PayPal/paypal-logo-wide-18.png b/docs/assets/images/PayPal/paypal-logo-wide-18.png deleted file mode 100644 index 1175e17284..0000000000 Binary files a/docs/assets/images/PayPal/paypal-logo-wide-18.png and /dev/null differ diff --git a/docs/assets/images/PayPal/paypal-logo-wide-24.png b/docs/assets/images/PayPal/paypal-logo-wide-24.png deleted file mode 100644 index 0dfac3ffc3..0000000000 Binary files a/docs/assets/images/PayPal/paypal-logo-wide-24.png and /dev/null differ diff --git a/docs/assets/images/PayPal/paypal-logo-wide-lg.png b/docs/assets/images/PayPal/paypal-logo-wide-lg.png deleted file mode 100644 index fa9f541da9..0000000000 Binary files a/docs/assets/images/PayPal/paypal-logo-wide-lg.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Logo_Black.png b/docs/assets/images/patreon/Digital-Patreon-Logo_Black.png deleted file mode 100644 index fd2b33ae16..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Logo_Black.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral.png b/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral.png deleted file mode 100644 index 83c3f8c10c..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral_16x16.png b/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral_16x16.png deleted file mode 100644 index 28bd4977bd..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Logo_FieryCoral_16x16.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Logo_White.png b/docs/assets/images/patreon/Digital-Patreon-Logo_White.png deleted file mode 100644 index 9a521e3fd6..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Logo_White.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Wordmark_Black.png b/docs/assets/images/patreon/Digital-Patreon-Wordmark_Black.png deleted file mode 100644 index a636c02599..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Wordmark_Black.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Wordmark_FieryCoral.png b/docs/assets/images/patreon/Digital-Patreon-Wordmark_FieryCoral.png deleted file mode 100644 index 8ba51a27b9..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Wordmark_FieryCoral.png and /dev/null differ diff --git a/docs/assets/images/patreon/Digital-Patreon-Wordmark_White.png b/docs/assets/images/patreon/Digital-Patreon-Wordmark_White.png deleted file mode 100644 index e5501de428..0000000000 Binary files a/docs/assets/images/patreon/Digital-Patreon-Wordmark_White.png and /dev/null differ diff --git a/docs/docs/commands.md b/docs/docs/commands.md deleted file mode 100644 index ab4fed90e9..0000000000 --- a/docs/docs/commands.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# See `_scripts/extract-commands.js` -layout: default -title: Commands -categories: docs -# parent: Docs -nav_order: 4 ---- - -{% include generated-docs/commands.md %} diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md deleted file mode 100644 index 03437a00eb..0000000000 --- a/docs/docs/configuration.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# See `_scripts/extract-config.js` -layout: default -title: Configuration Settings -categories: docs -# parent: Docs -nav_order: 4 ---- - -{% include generated-docs/configuration.md %} diff --git a/docs/docs/index.md b/docs/docs/index.md deleted file mode 100644 index 774c780530..0000000000 --- a/docs/docs/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Docs -nav_order: 4 -description: 'CSpell - A spell checker for code!' -has_children: true -nav_exclude: true ---- diff --git a/docs/docs/template.md b/docs/docs/template.md deleted file mode 100644 index b4a4801920..0000000000 --- a/docs/docs/template.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default -title: -categories: docs -parent: Docs -nav_order: 4 -published: false ---- - - - -# Title - -stuff here - -## More Detail - -## Examples diff --git a/docs/drafts/import.md b/docs/drafts/import.md deleted file mode 100644 index 6deaf2468b..0000000000 --- a/docs/drafts/import.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: post -title: How to Import Other Configuration Files -parent: Drafts -nav_exclude: true ---- - -# Importing Configuration Files - -... goes here. diff --git a/docs/drafts/index.md b/docs/drafts/index.md deleted file mode 100644 index 84aba050f2..0000000000 --- a/docs/drafts/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: default -title: Drafts -nav_order: 2 -has_children: true -nav_exclude: true ---- - -# Draft documents diff --git a/docs/favicon.ico b/docs/favicon.ico deleted file mode 100644 index f3d8017d4e..0000000000 Binary files a/docs/favicon.ico and /dev/null differ diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index db12459dd2..0000000000 --- a/docs/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# Feel free to add content and custom Front Matter to this file. -# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults -title: Spell Checker -nav_order: 1 -description: 'Spelling Checker for Visual Studio Code' -permalink: / ---- - -{% include generated-docs/README.md %} diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 1fbe8e14c2..0000000000 --- a/docs/package.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "@internal/docs", - "description": "Documentation", - "type": "commonjs", - "private": true, - "version": "0.0.0", - "scripts": { - "build": "echo Skip Docs", - "clean": "shx rm -rf _site", - "build-production": "echo Skip Docs", - "test": "echo Skip Docs", - "gen-docs": "npm run gen-config-docs && npm run gen-command-docs && npm run lint", - "gen-config-docs": "node _scripts/extract-config.mjs > _includes/generated-docs/configuration.md", - "gen-command-docs": "node _scripts/extract-commands.mjs > _includes/generated-docs/commands.md", - "lint": "prettier -w \"**/*.{md,markdown,yaml,yml,json,html,htm,js}\"", - "serve": "bundle exec jekyll serve" - }, - "engines": { - "node": ">20.0.0" - } -} diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md deleted file mode 100644 index bf600b3c17..0000000000 --- a/docs/release-notes/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Release Notes -nav_order: 5 -description: 'Release Notes for Code Spell Checker' -has_children: true ---- - -# Release Notes diff --git a/docs/release-notes/releasenotes_v2.md b/docs/release-notes/releasenotes_v2.md deleted file mode 100644 index f2a0ad4cc9..0000000000 --- a/docs/release-notes/releasenotes_v2.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -layout: default -title: Release Notes v2.0 -categories: release-notes -parent: Release Notes -nav_order: 4 ---- - -# Version 2.0 - -## Highlights - -- By default, only files in a workspace are spell checked. -- Be able to specify which files to check by adding globs to `files` setting. -- Spelling suggestions available from the context menu. -- Improved context menu options. -- Upgrades [cspell](https://www.npmjs.com/package/cspell) to version 5.9.0. -- Supports case sensitive dictionaries. See: [Turning on case sensitive spell checking](#turning-on-case-sensitive-spell-checking) -- Full support of Yaml configuration files: `cspell.config.yaml` -- Full support of configuration in `package.json` under `cspell` section. -- Partial support of JavaScript configuration files: `cspell.config.js` - The extension supports reading the configuration but can only write to `.json` and `.yaml` files. -- Supports dictionary entries that have numbers and mixed case. -- Supports more word splitting formats - It correctly splits both `ERRORcode` and `ERRORCode` -- Reduced installation size and faster loading -- Added Commands to move between issues in a document. See: [Previous and Next Issue Commands](#previous-and-next-issue-commands) - -## Manual Installation - -- Download and decompress `code-spell-checker.zip` from [VS Code Spell Checker Releases](https://github.com/streetsidesoftware/vscode-spell-checker/releases) -- From VS Code Install from VSIX `code-spell-checker-2.0.2.vsix` - ![image](https://user-images.githubusercontent.com/3740137/120071300-f0a27600-c08e-11eb-9828-155be0405510.png) - -# Features - -## Previous and Next Issue Commands - -| Command | Description | -| -------------------------------------------- | ----------------------------------------- | -| `cSpell.goToNextSpellingIssue` | Go to Next Spelling Issue | -| `cSpell.goToPreviousSpellingIssue` | Go to Previous Spelling Issue | -| `cSpell.goToNextSpellingIssueAndSuggest` | Go to Next Spelling Issue and Suggest | -| `cSpell.goToPreviousSpellingIssueAndSuggest` | Go to Previous Spelling Issue and Suggest | - -## Turning on case sensitive spell checking - -See: [Case Sensitivity - CSpell](https://streetsidesoftware.github.io/cspell/docs/case-sensitive/) - -**VS Code UI** - -![image](https://user-images.githubusercontent.com/3740137/129460586-498f1bf4-3b53-43d6-b525-7ad283b8e8bf.png) - -**VS Code `settings.json`** - -```jsonc -"cSpell.caseSensitive": true -``` - -**`cspell.json`** - -```jsonc -"caseSensitive": true -``` - -**For a file type: `markdown`** -`cspell.json` - -```jsonc -"languageSettings": [ - { "languageId": "markdown", "caseSensitive": true } -] -``` - -**For a file extension: `*.md`** -`cspell.json` - -```jsonc -"overrides": [ - { "filename": "*.md", "caseSensitive": true } -] -``` - -## Making Words Forbidden - -See: [How to Forbid Words - CSpell](https://streetsidesoftware.github.io/cspell/docs/forbidden-words/) - -# Contributions - -- [elazarcoh](https://github.com/elazarcoh) - added previous/next issue commands. - - diff --git a/docs/release-notes/releasenotes_v4.md b/docs/release-notes/releasenotes_v4.md deleted file mode 100644 index e98d41b329..0000000000 --- a/docs/release-notes/releasenotes_v4.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: Release Notes v4.0 -categories: release-notes -parent: Release Notes -nav_order: 4 ---- - -# Version 4.0.0 - Prerelease - -## Highlights - -- Upgrade to CSpell 8. -- Custom Decorators. -- Spelling issues moved to their own Panel. -- Word Trace mode to find dictionaries. -- CSpell REPL -- Hide spelling issues while typing. -- Toggle showing spelling issues. - -## Manual Installation - -- Download `code-spell-checker-*.vsix` from [VS Code Spell Checker Releases](https://github.com/streetsidesoftware/vscode-spell-checker/releases) -- From VS Code Install from VSIX `code-spell-checker-4.0.0.vsix` - ![image](https://user-images.githubusercontent.com/3740137/120071300-f0a27600-c08e-11eb-9828-155be0405510.png) - -## Features - -## Change Log - -- Support Virtual Workspaces ([#2971](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2971)) ([99c37d1](https://github.com/streetsidesoftware/vscode-spell-checker/commit/99c37d1178844175f27ae44917573a2307dc6ce8)) -- Enable workspace trust ([#2993](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2993)) ([15fe163](https://github.com/streetsidesoftware/vscode-spell-checker/commit/15fe16369b1e241ae49dc7758415b3a9982bcf08)) -- Support Word Tracing ([#2987](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2987)) ([001645b](https://github.com/streetsidesoftware/vscode-spell-checker/commit/001645beda5dc9bfa2f0b53f8a26d51a65f4a748)) -- Support loading local cspell dictionaries ([#2955](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2955)) ([d0ed69d](https://github.com/streetsidesoftware/vscode-spell-checker/commit/d0ed69db086c2db34e5483873ba1430327e9208a)) -- support custom decorators ([#2887](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2887)) ([d179d2e](https://github.com/streetsidesoftware/vscode-spell-checker/commit/d179d2e4cd0731bb1a2ebf627caf14b8d7c21edc)) -- Add command to autofix spelling issues. ([#2906](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2906)) ([356fae5](https://github.com/streetsidesoftware/vscode-spell-checker/commit/356fae553b255a1d71d58c1e62912e4fa12d789a)) -- Enable support for [Live Share](https://code.visualstudio.com/learn/collaboration/live-share) by adding `vsls` to the list of supported schemes. ([76e1583](https://github.com/streetsidesoftware/vscode-spell-checker/commit/76e1583e8e6f2c7cdc0e0211074da565bf3f0e52)) -- CSpell REPL ([#3109](https://github.com/streetsidesoftware/vscode-spell-checker/issues/3109)) ([5047a1d](https://github.com/streetsidesoftware/vscode-spell-checker/commit/5047a1d71588af64f30b880349aa2db31aa19d0a)) -- Hide spelling issues while typing. ([#3233](https://github.com/streetsidesoftware/vscode-spell-checker/issues/3233)) ([fbd5134](https://github.com/streetsidesoftware/vscode-spell-checker/commit/fbd513486f6bf4a0e17f40932b0cca8b4481b757)) -- Simplify file type and scheme settings ([#3244](https://github.com/streetsidesoftware/vscode-spell-checker/issues/3244)) ([151e7bf](https://github.com/streetsidesoftware/vscode-spell-checker/commit/151e7bf29909c4257966f820a99bc89e4810961e)) - -# Fixes - -- reduce reloading when opening a cspell config ([#2986](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2986)) ([a8a1e18](https://github.com/streetsidesoftware/vscode-spell-checker/commit/a8a1e1810b550d966c157d093ed50625244f3340)) -- Add link to suggestions ([#2888](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2888)) ([eff9c8c](https://github.com/streetsidesoftware/vscode-spell-checker/commit/eff9c8cadb3ce4cc62a4dd140ae3e79e8495bae5)) -- Add suggestions to hover ([#2896](https://github.com/streetsidesoftware/vscode-spell-checker/issues/2896)) ([cf88324](https://github.com/streetsidesoftware/vscode-spell-checker/commit/cf8832486f8d768a8a5d24a9c1dfda721ce02dac)) diff --git a/docs/release-notes/template.md b/docs/release-notes/template.md deleted file mode 100644 index fb9caba5b0..0000000000 --- a/docs/release-notes/template.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default -title: -categories: release-notes -parent: Release Notes -nav_order: 4 -nav_exclude: true -published: false ---- - - - -# Title - -stuff here - -## More Detail - -## Examples diff --git a/eslint.config.js b/eslint.config.js index 5ef9b69474..1b968d8904 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -33,7 +33,6 @@ export default tsEslint.config( '**/scripts/ts-json-schema-generator.cjs', '**/temp/**', '**/webpack*.js', - 'docs/docsV2/**', 'package-lock.json', 'packages/*/dist/**', 'packages/*/out/**', diff --git a/package-lock.json b/package-lock.json index 0f352a3784..e8c18f5e29 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,8 +10,6 @@ "hasInstallScript": true, "license": "GPL-3.0-or-later", "workspaces": [ - "docs", - "docs/_scripts", "tools/build-tools", "packages/utils-logger", "packages/utils-disposables", @@ -71,12 +69,14 @@ "docs": { "name": "@internal/docs", "version": "0.0.0", + "extraneous": true, "engines": { "node": ">20.0.0" } }, "docs/_scripts": { "name": "docs_scripts", + "extraneous": true, "devDependencies": { "@types/json-schema": "^7.0.15" }, @@ -4150,10 +4150,6 @@ "resolved": "packages/__utils", "link": true }, - "node_modules/@internal/docs": { - "resolved": "docs", - "link": true - }, "node_modules/@internal/integration-tests": { "resolved": "packages/_integrationTests", "link": true @@ -4166,6 +4162,10 @@ "resolved": "packages/_serverPatternMatcher", "link": true }, + "node_modules/@internal/website": { + "resolved": "website", + "link": true + }, "node_modules/@isaacs/cliui": { "version": "8.0.2", "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", @@ -10033,10 +10033,6 @@ "node": ">=6" } }, - "node_modules/docs_scripts": { - "resolved": "docs/_scripts", - "link": true - }, "node_modules/dom-converter": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", @@ -16079,10 +16075,6 @@ "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", "dev": true }, - "node_modules/my-website": { - "resolved": "website", - "link": true - }, "node_modules/nanoid": { "version": "3.3.7", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", @@ -24289,7 +24281,7 @@ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" }, "website": { - "name": "my-website", + "name": "@internal/website", "version": "0.0.0", "dependencies": { "@docusaurus/core": "3.3.2", diff --git a/package.json b/package.json index db3c10e469..6216e1bd87 100644 --- a/package.json +++ b/package.json @@ -3962,8 +3962,6 @@ } }, "workspaces": [ - "docs", - "docs/_scripts", "tools/build-tools", "packages/utils-logger", "packages/utils-disposables", @@ -3985,7 +3983,7 @@ "build": "npm run build:workspaces && npm run build:schema", "build:docs": "npm run gen-docs", "build:all": "npm run build && npm run build:docs", - "build:readme": "inject-markdown README.md && prettier -w README.md && inject-markdown docs website && prettier -w docs website", + "build:readme": "inject-markdown README.md && prettier -w README.md && inject-markdown website && prettier -w website", "build:schema": "npm run build-package-schema", "build:workspaces": "npm --workspaces --if-present run build", "build:extension": "npm run package-extension", @@ -3993,7 +3991,7 @@ "build-production": "npm --workspaces --if-present run build-production", "build-release": "npm run build && npm run package-extension", "build-website": "cd website && npm i && npm run build-site", - "gen-docs": "npm --workspace=@internal/docs run gen-docs", + "gen-docs": "npm --if-present run gen-docs", "package-extension": "vsce package --pre-release -o ./build", "prettier:check": "prettier . -c", "prettier:fix": "npm run prettier:check -- -w", @@ -4003,8 +4001,8 @@ "vscode:prepublish": "npm run build-production && npm run remove-test-files", "lint": "npm run lint:eslint && npm run prettier:fix", "lint:eslint": "eslint . --fix --cache", - "lint-docs": "prettier -w \"docs/**/*.{md,markdown,yaml,yml,json,html,htm,js,ts}\"", - "lint-docs-ci": "prettier -c \"docs/**/*.{md,markdown,yaml,yml,json,html,htm,js,ts}\"", + "lint-docs": "prettier -w website", + "lint-docs-ci": "prettier -c website", "test-client-integration": "npm --workspace=@internal/integration-tests run test-integration", "test": "npm --workspaces --if-present run test && echo OK", "update-cspell": "npx npm-check-updates --root -ws --target semver -u \"cspell*\" \"@cspell/*\" && npm i", diff --git a/website/README.md b/website/README.md index 0c6c2c27be..456f5b1478 100644 --- a/website/README.md +++ b/website/README.md @@ -39,3 +39,7 @@ $ GIT_USER= yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. + +## Legacy Website + +The Jekyll website was under [/docs](https://github.com/streetsidesoftware/vscode-spell-checker/blob/ca954e048a173f805dbabae4fe2d4f23e213c6ca/docs). diff --git a/website/package.json b/website/package.json index deb6c3a7cd..467a139c6b 100644 --- a/website/package.json +++ b/website/package.json @@ -1,5 +1,5 @@ { - "name": "my-website", + "name": "@internal/website", "version": "0.0.0", "private": true, "scripts": {