Skip to content

Commit

Permalink
ci: Update ALL Dependencies (main) -- Workflow Bot (#3841)
Browse files Browse the repository at this point in the history
Co-authored-by: Jason3S <[email protected]>
Co-authored-by: Jason Dent <[email protected]>
  • Loading branch information
3 people authored Nov 26, 2024
1 parent a25b88a commit d18ddcb
Show file tree
Hide file tree
Showing 25 changed files with 622 additions and 622 deletions.
30 changes: 15 additions & 15 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ If anything shows up, then the port is still locked.

## Packages

- `client` - the actual extension running in VS Code.
- `_server` - the extension server that processes spell checker requests
- `_settingsViewer` - a webapp that provides a visual interface to the configuration files.
- `_integrationTests` - a test suite that launches the extension in VS Code.
- `client` - the actual extension running in VS Code.
- `_server` - the extension server that processes spell checker requests
- `_settingsViewer` - a webapp that provides a visual interface to the configuration files.
- `_integrationTests` - a test suite that launches the extension in VS Code.

## Adding configurations

Expand Down
278 changes: 139 additions & 139 deletions README.md

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions design-docs/spelling-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Fixing spelling errors is usually done with a Command. The idea is to record eac

Things to record:

- `word`<sup>\*</sup> - the word with the spelling error. This could be the word or a hash.
- `replacement`<sup>\*</sup> - the replacement chosen. This could be a word or a hash.
- `timestamp` - the Unix timestamp in milliseconds. Helps use keep track of the order and to diminish weight over time.
- `fileType` - the file type (LanguageID) of the file.
- `locale` - the current locale setting.
- `scheme` - the URI scheme
- `machineId` - a hash of the machine id (does not need to be unique, just consistent).
- `userId` - a hash of the user id (does not need to be unique, just consistent).
- `word`<sup>\*</sup> - the word with the spelling error. This could be the word or a hash.
- `replacement`<sup>\*</sup> - the replacement chosen. This could be a word or a hash.
- `timestamp` - the Unix timestamp in milliseconds. Helps use keep track of the order and to diminish weight over time.
- `fileType` - the file type (LanguageID) of the file.
- `locale` - the current locale setting.
- `scheme` - the URI scheme
- `machineId` - a hash of the machine id (does not need to be unique, just consistent).
- `userId` - a hash of the user id (does not need to be unique, just consistent).

<sup>\*</sup> - Necessary fields needed to make the suggestions.

Expand All @@ -32,7 +32,7 @@ Word Frequency can be used to improve suggestions by pushing words that already

Record:

- `word` - the text of the word. (prefer whole words over camel case splits). We might want to limit the length less than 64 characters or use a hash.
- `count` - the number of times the word was seen in the file.
- `fileType` - the file type (LanguageId) of the file.
- `fileId` - the id of the file
- `word` - the text of the word. (prefer whole words over camel case splits). We might want to limit the length less than 64 characters or use a hash.
- `count` - the number of times the word was seen in the file.
- `fileType` - the file type (LanguageId) of the file.
- `fileId` - the id of the file
52 changes: 26 additions & 26 deletions design-docs/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,56 +7,56 @@ Issues should be tracked with the `v2` milestone.

### Modifying config files

- [x] Make sure the `cspell.config.js` does not get modified by the extension when changing words or settings.
- [x] Make sure the correct `cspell*.json` files are updated when writing settings.
- [x] Support `package.json` as a target location for `cspell` settings.
- [x] Support `yaml` config files.
- [x] Support concept of readonly configuration files.
- [x] Verify Yarn 2 support
- [x] Make sure the `cspell.config.js` does not get modified by the extension when changing words or settings.
- [x] Make sure the correct `cspell*.json` files are updated when writing settings.
- [x] Support `package.json` as a target location for `cspell` settings.
- [x] Support `yaml` config files.
- [x] Support concept of readonly configuration files.
- [x] Verify Yarn 2 support

### Commands

- [ ] Ignore word should update the correct files.
- [ ] Feature: create dictionary command.
- [x] Create config file command
- [ ] Ignore word should update the correct files.
- [ ] Feature: create dictionary command.
- [x] Create config file command

### Non-File URIs

- [x] Support `untitled` file schema.
- [ ] Support non-`file` schemas.
- [x] Support `untitled` file schema.
- [ ] Support non-`file` schemas.

### Preferences

- [x] Support checking only files in the Workspace
- [ ] Support setting preferences for config location.
- [x] Support checking only files in the Workspace
- [ ] Support setting preferences for config location.

### Documentation

- [ ] Document how to setup a custom dictionary
- [ ] Document how to setup a custom dictionary

### Context Menu

- [x] Fix the options listed in the context menu to include `cspell` as a destination for words
- [x] Do not split words when adding to dictionary.
- [x] When adding a word that is a Diagnostic to the dictionary, do not ask.
- [x] Fix the options listed in the context menu to include `cspell` as a destination for words
- [x] Do not split words when adding to dictionary.
- [x] When adding a word that is a Diagnostic to the dictionary, do not ask.

### Reliability

- [ ] Detect server hangs
- [ ] Warn about documents that take too long to check.
- [ ] Be able to block documents that take too long to check.
- [ ] Be able to re-start the server if necessary.
- [ ] Be able to kill the server if stuck.
- [ ] Detect server hangs
- [ ] Warn about documents that take too long to check.
- [ ] Be able to block documents that take too long to check.
- [ ] Be able to re-start the server if necessary.
- [ ] Be able to kill the server if stuck.

### Bug Fixes

- [x] Fix issue with Accents
- [ ] Support for case sensitive dictionaries.
- [x] Fix issue with Accents
- [ ] Support for case sensitive dictionaries.

### Third-party issues

- [ ] [Support virtual workspaces · Issue #846 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/846)
- [ ] [Support Workspace Trust · Issue #839 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/839)
- [ ] [Support virtual workspaces · Issue #846 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/846)
- [ ] [Support Workspace Trust · Issue #839 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/839)

Workspace Trust is going to require some modifications to `cspell` in order to prevent it from
loading any untrusted sources.
Expand Down
44 changes: 22 additions & 22 deletions design-docs/v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Checklist

- [ ] Update README.md to match v4
- [ ] Event Log
- [ ] Record Spelling Corrections / Suggestions Used
- [ ] Sponsorship message
- [ ] Analytics
- [ ] Update README.md to match v4
- [ ] Event Log
- [ ] Record Spelling Corrections / Suggestions Used
- [ ] Sponsorship message
- [ ] Analytics

## README.md

Expand All @@ -30,31 +30,31 @@ The idea is to store the suggestions the user has picked and present them at the

Compose a sponsorship message to show users.

- Should describe why it is important to become a sponsor
- Provide a link to the Sponsor page.
- Should only be shown if they are using the extension.
- The User can hide the message for about a month, longer if they are a sponsor.
- Should describe why it is important to become a sponsor
- Provide a link to the Sponsor page.
- Should only be shown if they are using the extension.
- The User can hide the message for about a month, longer if they are a sponsor.

## Analytics / Telemetry Data

At the moment, the Spell Checker does not collect any Telemetry data. But that is likely to change:

- User must be able to op-out.
- Special care should be made to avoid collecting any sensitive or personally identifiable information.
- User must be able to op-out.
- Special care should be made to avoid collecting any sensitive or personally identifiable information.

### Reasons for Data Collection

- Usage:
- Approximate number of unique users. The key here is to be able to distinguish between users, but not to identify an individual.
- Frequency of use.
- Feature usage.
- Errors:
- Record any Error events.
- Usage:
- Approximate number of unique users. The key here is to be able to distinguish between users, but not to identify an individual.
- Frequency of use.
- Feature usage.
- Errors:
- Record any Error events.

### Metrics

- Throughput
- Words / Second
- Kilobytes / Second
- File type
- Line width (Avg,Med,Max)
- Throughput
- Words / Second
- Kilobytes / Second
- File type
- Line width (Avg,Med,Max)
4 changes: 2 additions & 2 deletions design-docs/wip/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,5 +132,5 @@ Priority should be strongly towards local (_folder_) over global (_user_).

Notes:

- if a CSpell configuration file contains a custom dictionary definition it should not be part of the selection.
- Adding words should not create a CSpell configuration file or a VS Code `settings.json` file is avoidable.
- if a CSpell configuration file contains a custom dictionary definition it should not be part of the selection.
- Adding words should not create a CSpell configuration file or a VS Code `settings.json` file is avoidable.
8 changes: 4 additions & 4 deletions fixtures/workspaces/unknown-words/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

This is an exaple with some common errors:

- recieve -> receive
- simpel -> simple
- comon -> common
- thiswodshaserrors: but it isn't reported.
- recieve -> receive
- simpel -> simple
- comon -> common
- thiswodshaserrors: but it isn't reported.

This is a peom about recieving incorect words. Not all of them are highlited or hilighted or even highlighted.
More comon mispellings like polution are flaged.
Expand Down
Loading

0 comments on commit d18ddcb

Please sign in to comment.