### Getting Started CLI Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt A command-line argument example for ESLint's getting started guide, specifying a file to lint. ```bash args: ["yourfile.js"] ``` -------------------------------- ### Getting Started npmjs Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt A reference to npmjs.com for finding ESLint configurations, specifically mentioning 'eslint-config' packages. ```text "eslint-config" on [npmjs.com](https://www.npmjs ``` -------------------------------- ### InstallUtil Example in PowerShell Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt An example of running the InstallUtil command in a PowerShell environment, often used for installing .NET assemblies. ```powershell installutil "GetProcessSample01 ``` -------------------------------- ### Get Process Cmdlet Tutorial Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt A tutorial demonstrating the use of the Get-Process cmdlet. This example is part of a series of tutorials. ```powershell cmdlet/getproc-tutorial.md ``` -------------------------------- ### Get Process Sample 01 Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Sample code for the Get-Process cmdlet, part of a series of examples. ```powershell cmdlet/getprocesssample01-sample.md ``` -------------------------------- ### Start a PowerShell Job Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Example of starting a PowerShell background job. This snippet shows how to define and start a job. ```PowerShell Start-Job -ScriptBlock { Get-Process | Out-String } ``` -------------------------------- ### Get Process Sample 05 Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Sample code for the Get-Process cmdlet, part of a series of examples. ```powershell cmdlet/getprocesssample05-sample.md ``` -------------------------------- ### Get Process Sample 03 Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Sample code for the Get-Process cmdlet, part of a series of examples. ```powershell cmdlet/getprocesssample03-sample.md ``` -------------------------------- ### Get Process Sample 02 Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Sample code for the Get-Process cmdlet, part of a series of examples. ```powershell cmdlet/getprocesssample02-sample.md ``` -------------------------------- ### Install Dependencies Source: https://github.com/streetsidesoftware/cspell/blob/main/website/README.md Installs the necessary tools and dependencies for the project. ```bash $ corepack enable $ pnpm i ``` -------------------------------- ### Start Process with nohup Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Use Start-Process to launch a process. This example demonstrates using 'nohup' to run a PowerShell command and redirect output. ```PowerShell Start-Process nohup 'pwsh -NoProfile -c ``` ```PowerShell appends output to ./nohup.out ``` -------------------------------- ### Node.js Execution Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Basic examples of running Node.js scripts from the command line. ```bash node my-app.js ``` -------------------------------- ### Get Process Sample 04 Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Sample code for the Get-Process cmdlet, part of a series of examples. ```powershell cmdlet/getprocesssample04-sample.md ``` -------------------------------- ### Install Software Terms Dictionary Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/dictionaries/software-terms/README.md Globally install the dictionary and link it to cspell. ```sh npm install -g @cspell/dict-software-terms cspell link add @cspell/dict-software-terms ``` -------------------------------- ### Plugin Configuration Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt An example of how to specify a custom ESLint plugin in a configuration file. ```javascript modules/eslint-plugin-someplugin/index.js ``` -------------------------------- ### Example Command Execution Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Illustrative examples of commands that can be executed, such as listing directory contents or searching for processes. ```bash ls -lh /usr ``` ```bash ps ax | grep ssh ``` ```bash bash some-command ``` -------------------------------- ### Configuration File Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt An example of a configuration setting for language names, potentially used in ESLint or similar tools. ```json nguageName"`, e.g. `"markdown/commonmark"`. (default: `"js/js ``` -------------------------------- ### Start Local Development Server Source: https://github.com/streetsidesoftware/cspell/blob/main/website/README.md Starts a local development server that reflects changes live without requiring a restart. ```bash $ pnpm start ``` -------------------------------- ### Install flatpack-json Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/flatpack-json/README.md Install the flatpack-json library using npm. ```sh npm install -S flatpack-json ``` -------------------------------- ### Install and Lint with Yarn Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/yarn/cspell-eslint-plugin/README.md Run these commands to install dependencies and perform a lint check using Yarn. ```bash yarn yarn lint ``` -------------------------------- ### Install @cspell/dynamic-import Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/dynamic-import/README.md Install the library using npm. ```sh npm install -S @cspell/dynamic-import ``` -------------------------------- ### Node.js Path Resolution Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Examples of resolving paths using path.resolve(). ```javascript path.resolve( /foo , /bar , baz ) ``` ```javascript path.resolve( C: ) ``` ```javascript path.resolve( C:\ ) ``` ```javascript path.resolve() ``` ```javascript path.resolve([...paths]) ``` -------------------------------- ### Install @cspell/cspell-pipe Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-pipe/README.md Install the library using npm. ```sh npm install -S @cspell/cspell-pipe ``` -------------------------------- ### WSMan Provider Configuration Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Examples related to WSMan provider configuration, including authorization and parameter names. ```powershell AU;FA;GA;;;WD)(AU;SA;GWGX;;;WD)" ``` ```powershell itialization parameter named "testparametername" ``` ```powershell -ParamName testparametername ` ``` ```powershell -ParamValue testparametervalue ``` ```powershell represents the XML as a **PCWSTR** memory buffer. ``` -------------------------------- ### Install @cspell/filetypes Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-filetypes/README.md Install the library using npm. ```sh npm install -S @cspell/filetypes ``` -------------------------------- ### Install @cspell/strong-weak-map Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-strong-weak-map/README.md Install the package using npm. ```sh npm install -S @cspell/strong-weak-map ``` -------------------------------- ### Install cspell-gitignore Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-gitignore/README.md Install the library as a project dependency. ```sh npm install -S cspell-gitignore ``` -------------------------------- ### Integrations Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt An example listing an integration with 'Syntastic', a syntax checker for Vim. ```markdown - [Syntastic](https://github.com ``` -------------------------------- ### Install cspell-json-reporter Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/README.md Install the reporter as a development dependency using npm. ```sh npm install -SD @cspell/cspell-json-reporter ``` -------------------------------- ### Install @cspell/dictionary-bundler-plugin Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md Install the dictionary bundler plugin as a development dependency. ```bash npm i -D @cspell/dictionary-bundler-plugin ``` -------------------------------- ### Install cspell-config Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-config-lib/README.md Install the cspell-config library using npm. ```sh npm install -S cspell-config ``` -------------------------------- ### Install hunspell-reader Globally Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/hunspell-reader/README.md Install the hunspell-reader as a global command-line tool. ```bash npm install -g hunspell-reader ``` -------------------------------- ### CSpell Command Example Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/docs/configuration.md Example of how to run the CSpell command to check markdown files within a repository. ```bash repo-root % cspell "**/*.md" ``` -------------------------------- ### CustomControl Configuration Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Example of a CustomControl configuration, specifically showing CustomEntries within a control. ```powershell customentries-element-for-customcontrol-for-controls-for-configuratio ``` -------------------------------- ### Dart SQLite Minututorial Reference Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/dart-lang/sdk/snapshot.txt This refers to a mini-tutorial for using SQLite with Dart, suggesting a simplified guide for getting started. ```markdown In this minitutorial we used these `dart ``` -------------------------------- ### Command Line Interface Configuration Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt Shows how to specify configuration options via the command line, including using 'levn' for configuration and custom formatters. ```bash configuration specified with [levn](https://github.com ``` ```bash args: ["-f", "./customformat.js", "file.js"] ``` -------------------------------- ### cspell-gitignore CLI Example Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-gitignore/README.md An example demonstrating how to use the `cspell-gitignore` CLI to check files against .gitignore rules, specifying a root directory. ```sh $ cspell-gitignore -r . node_modules .gitignore:58:node_modules/ node_modules ``` -------------------------------- ### Install CSpell-Tools CLI Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-tools/README.md Install the cspell-tools command-line interface globally using npm. ```sh npm install -g @cspell/cspell-tools ``` -------------------------------- ### Manual Installation of Dictionary Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/dictionaries/software-terms/README.md Add the cspell-ext.json file to your cspell.json import section for manual installation. ```javascript { // … "import": ["@cspell/dict-software-terms/cspell-ext.json"], // … } ``` -------------------------------- ### Frequency Finder Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/TheAlgorithms/Python/snapshot.txt Shows examples of frequency analysis with predefined character sets. ```Python ETAOIN = "ETAOINSHRDLCUMWFGYPBVKJXQZ" ETAOIN = "ETAOINSHRDLCUMWFGYPBVKJXQZ" 'LOWDRHEZQXJKVBPYGFMUCSNIAT' 'LHOEZQXJKVBPYGFWMUCDRSNIAT' 'HZQXJKVBPYGFWMUCLDRSNIOATE' ``` -------------------------------- ### Primary Key Guid Generation Test Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/aspnetboilerplate/aspnetboilerplate/snapshot.txt This test verifies GUID generation for primary keys, with an example for 'Tesk book store'. ```csharp test/Abp.ZeroCore.Tests/Zero/PrimaryKey_Guid_Generation_Tests.cs:71:25 - Unknown word (Tesk) -- Name = "Tesk book store" ``` -------------------------------- ### PowerShell SQL Server Connection String Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/ktaranov/sqlserver-kit/snapshot.txt Example of setting a SQL Server connection string, potentially for a cluster environment. ```powershell -sqlserver sqlcluster -Database locations ``` -------------------------------- ### Select String Cmdlet Tutorial Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt A tutorial demonstrating the use of the Select-String cmdlet. This example is part of a series of tutorials. ```powershell cmdlet/selectstr-tutorial.md ``` -------------------------------- ### Child Process `sub.js` Example Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt An example file named `sub.js` that might be executed as a child process. ```javascript sub.js ``` -------------------------------- ### Example of New-PSSession configuration Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Illustrates creating a new PowerShell session with a specific computer name and credentials. ```powershell New-PSSession -ComputerName Server1.Domain44.Corpnet.Fabrikam.com -Credential ``` -------------------------------- ### Socket Listen Options Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Examples of options for configuring socket connections. ```javascript { path: path } ``` -------------------------------- ### PHP ZipArchive Create Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/php/php-src/snapshot.txt Demonstrates creating a new zip archive using `ZipArchive::CREATE`. It opens the archive and checks for success. ```php $z->open('a.zip', ZIPARCHIVE::CREATE); ``` ```php $z->open('a.zip', ZIPARCHIVE::CREATE); ``` ```php zip->open($filename, ZIPARCHIVE::CREATE)) ``` -------------------------------- ### Suspend Service with Suspend-Service Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Use Suspend-Service to pause a running service. This example is relevant for services whose names start with 'lanman'. ```PowerShell starts with lanman. To suspend the services ``` -------------------------------- ### Get Windows Events by Log Name Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Example of retrieving Windows events from a specific log. This snippet demonstrates filtering by Logname. ```PowerShell Get-WinEvent -FilterXPath "*[System[Logname='Application']]" ``` -------------------------------- ### Node.js Path Manipulation Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Provides examples of using the built-in 'path' module for manipulating file and directory paths. ```javascript require( path ).posix ``` ```javascript require( path ).win32 ``` ```javascript require( path/posix ) ``` ```javascript require( path/win32 ) ``` ```javascript path.join([...paths]) ``` ```javascript path.resolve( /foo , /bar , baz ) ``` ```javascript path.resolve( C: ) ``` ```javascript path.resolve( C:\ ) ``` ```javascript path.resolve() ``` ```javascript path.resolve([...paths]) ``` ```javascript path.normalize(path) ``` ```javascript path.parse(path) ``` ```javascript path.basename(path[, ext]) ``` ```javascript path.dirname(path) ``` ```javascript path.extname(path) ``` ```javascript path.format(pathObject) ``` ```javascript path.relative(from, to) ``` ```javascript path.isAbsolute(path) ``` ```javascript path.toNamespacedPath(path) ``` -------------------------------- ### Example of Get-Command usage Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Demonstrates using Get-Command to find commands related to a specific module. ```powershell Get-Command -Module modulename ``` -------------------------------- ### Get Performance Counter Samples Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Example of retrieving performance counter samples for processes. This snippet demonstrates how to use Get-Counter and sort the results. ```PowerShell $Procs = Get-Counter -Counter "\Process(*)\% Processor Time" $Procs.CounterSamples | Sort-Object -Property CookedValue -Descending ``` -------------------------------- ### Example of Import-Module with remote computer Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Illustrates importing a module from a remote computer using a CimSession. ```powershell Import-Module -CimSession -ComputerName RSDGF03 ``` -------------------------------- ### Fetch Anime Episode List Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/TheAlgorithms/Python/snapshot.txt Example of calling a function to get a list of episodes for a specific anime. Demonstrates accessing a nested resource. ```Python # Unknown word (kimetsu) -- episode_list("/anime/kimetsu-no-yaiba")) # Unknown word (yaiba) -- list("/anime/kimetsu-no-yaiba")) ``` -------------------------------- ### Django slice filter usage Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/django/django/snapshot.txt Example of the slice filter, used to extract a portion of a string or list. The format 'start:end' specifies the slice. ```python abcdefg", "0::2"), "aceg") ``` -------------------------------- ### MDX with Recma Plugins Configuration Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt Shows how to configure `recmaPlugins` within an MDX processing setup. This example demonstrates passing an array of plugins to the configuration. ```js ```js // Configuration with multiple recma plugins import recmaBabel from 'recma-babel'; const mdxConfig = { recmaPlugins: [recmaBabel /*, other plugins */], jsxImportSource: 'react' // Example of another option }; ``` ``` -------------------------------- ### Get-FileHash Example with Package URL Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Demonstrates using Get-FileHash with a package URL. Ensure the URL is accessible and the content is downloadable. ```powershell $pkgurl = 'https://github.com ``` ```powershell InputStream ( $wc.OpenRead($pkgurl) ) ``` -------------------------------- ### Get Windows Events with Time Filter Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Example of retrieving Windows events filtered by time. This snippet shows how to use the TimeCreated property with a timediff condition. ```PowerShell Get-WinEvent -FilterXPath "*[System[(Level=3) and TimeCreated[timediff(@SystemTime) <= 86400000]]]" ``` -------------------------------- ### Hash Table Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Demonstrates a hash table with a key related to Windows services. ```PowerShell System.ServiceProcess.Servi ``` -------------------------------- ### Basic Jira Library Usage Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/pycontribs/jira/snapshot.txt A fundamental example demonstrating basic interaction with the Jira API, such as retrieving comments made by a specific user. This is a starting point for many Jira automation tasks. ```python # all comments made by Atlassians on this issue. # remote jira issue (needs applinks to be configured to ``` -------------------------------- ### SQL Server Table Creation with Schema and Database Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/ktaranov/sqlserver-kit/snapshot.txt Example of creating a table with a fully qualified name including database, schema, and table name. Ensure correct casing and naming conventions for database objects. ```sql CREATE TABLE PRODSERVER.PRODDB.dbo.MyTable (MyColumn ``` -------------------------------- ### Server Listen Overloads Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Demonstrates various ways to call `server.listen` to start a server listening on a specific port, host, or path. ```javascript server.listen() ``` ```javascript server.listen(handle) ``` ```javascript server.listen(handle[, backlog][, callback]) ``` ```javascript server.listen(options) ``` ```javascript server.listen(options[, callback]) ``` ```javascript server.listen(path) ``` ```javascript server.listen(path[, backlog][, callback]) ``` -------------------------------- ### Install @cspell/normalize-json Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-normalize-json/README.md Install the package using npm. ```sh npm install -S @cspell/normalize-json ``` -------------------------------- ### Server Listen Options Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/cspell-tools/test-cspell-tools/src/node.txt Examples of options passed to `server.listen` for specifying port, host, and family. ```javascript { port: 12346, family: IPv4 , address: 127.0.0.1 } ``` ```javascript {port: port, host: host} ``` -------------------------------- ### Example of Get-Module with CimSession Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Shows how to use Get-Module with a CimSession to connect to a remote computer. ```powershell Get-Module -CimSession -ComputerName RSDGF03 ``` -------------------------------- ### Receive PSSession with Parameters Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt This example shows how to define and use a hashtable of parameters (`$parms`) for the `Receive-PSSession` and `Invoke-Command` cmdlets. This allows for flexible configuration of session operations. ```powershell $parms = @{ ``` ```powershell Receive-PSSession @parms ``` ```powershell PS> $parms = @{ ``` ```powershell PS> Invoke-Command @parms ``` -------------------------------- ### Install cspell-trie-lib Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-trie-lib/README.md Install the cspell-trie-lib package using npm. ```sh npm install -S cspell-trie-lib ``` -------------------------------- ### Example of Save-Help with CimSession Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Demonstrates creating a CimSession object to be used with Save-Help for remote help updates. ```powershell $cimsession = New-CimSession -ComputerNam ``` -------------------------------- ### Install cspell-lib Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/README.md Install the cspell-lib package as a development dependency. ```bash npm i -S cspell-lib ``` -------------------------------- ### Debug Configuration Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt Illustrates a configuration path for ESLint debugging, referencing a user's project directory. ```text config from C:\Users\nzakas\projects\eslint\eslint ``` -------------------------------- ### Palindrome Check Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/TheAlgorithms/Python/snapshot.txt Provides an example of a string that is not a palindrome. ```Python "abcdba": False, ``` -------------------------------- ### Install CSpell Types Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-types/README.md Install the cspell-types package as a development dependency. ```bash npm i -S @cspell/cspell-types ``` -------------------------------- ### CSpell Init Command Options (Full) Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/release-notes.md Full set of options for the `cspell init` command, covering configuration path, output, format, imports, locales, dictionaries, and comments. ```bash Usage: cspell init [options] Initialize a CSpell configuration file. Options: -c, --config Path to the CSpell configuration file. Conflicts with --output and --format. -o, --output Define where to write file. --format Define the format of the file. (choices: "yaml", "yml", "json", "jsonc", default: "yaml") --import Import a configuration file or dictionary package. --locale Define the locale to use when spell checking (e.g., en, en-US, de). --dictionary Enable a dictionary. Can be used multiple times. --no-comments Do not add comments to the config file. --remove-comments Remove all comments from the config file. --no-schema Do not add the schema reference to the config file. --stdout Write the configuration to stdout instead of a file. -h, --help display help for command ``` -------------------------------- ### Create Project Dictionary File Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/getting-started.mdx Use this command to create a new file for your project-specific words. ```sh touch project-words.txt ``` -------------------------------- ### Install cspell-trie Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-trie/README.md Install the cspell-trie tool globally using npm. ```sh npm install -g cspell-trie ``` -------------------------------- ### Reading User Input with Read-Host Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt This example shows how to use Read-Host to prompt the user for input. The input can be a comma-separated list of values. ```powershell Read-Host -Prompt "'New York; Osan; Koforidua'" ``` -------------------------------- ### Stop Process Cmdlet Tutorial Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt A tutorial demonstrating the use of the Stop-Process cmdlet. This example is part of a series of tutorials. ```powershell cmdlet/stopproc-tutorial.md ``` -------------------------------- ### Install @cspell/url Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-url/README.md Install the @cspell/url package using npm. This is a dependency for cspell. ```sh npm install -S @cspell/url ``` -------------------------------- ### PowerShell Cmdlet Sample Paths Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Provides example paths for PowerShell cmdlet samples, often used in development and testing scenarios. ```powershell Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp ``` -------------------------------- ### Install CSpell Resolver Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-resolver/README.md Install the CSpell Resolver package using npm. ```sh npm install -S @cspell/cspell-resolver ``` -------------------------------- ### Writing Process Information to a File with Out-File Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt This example demonstrates how to capture process information into a variable and then write it to a file using Out-File. It specifies ASCII encoding and a width for the output. ```powershell $Procs = Get-Process $logFile = "$PWD\logfile.txt" Process.txt -InputObject $Procs -Encoding ascii -Width 100 | Out-File -FilePath $logFile ``` -------------------------------- ### Example Dictionary Suggestion Costs Configuration Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0002 improve dictionary suggestions/README.md YAML configuration demonstrating how to define custom costs for various scenarios, including accented characters, vowels, multi-character mappings, and keyboard adjacency. This allows fine-tuning suggestion relevance. ```yaml costs: - description: Accented Vowel Letters map: 'aáâäãå|eéêë|iíîï|oóôöõ|uúûü|yÿ' insDel: 50 replace: 10 - description: Vowels map: 'aáâäãåeéêëiíîïoóôöõuúûüyÿ' insDel: 50 replace: 25 # Replacing one vowel with another is cheap swap: 25 # Swapping vowels are cheap - description: Multi Character example map: 'ß(ss)|œ(ae)|f(ph)' replace: 10 - description: Appending / Removing Accent Marks map: '\u0641' # Shadda insDel: 10 - description: Arabic Vowels map: '\u064f\u0648\u064e\u0627\u0650\u64a\u0652' # Damma, Wāw, Fatha, Alif, Kasra, Ya', Sukūn insDel: 20 replace: 20 - description: Keyboard Adjacency map: 'qwas|aszx|wesd|sdxc|erdf|dfcv|rtfg|fgvb|tygh|ghbn|yuhj|hjnm|uijk|jkm|iokl|opl' replace: 50 # make it cheaper to replace near-by keyboard characters ``` -------------------------------- ### Use IsNaN Rule Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt A simple example indicating the 'use-isnan' rule. ```javascript title: use-isnan ``` -------------------------------- ### Get Zip Filename Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/php/php-src/snapshot.txt Internal function to get the filename from a zip object. ```c static char * php_zipobj_get_filename(ze_zip_object ``` -------------------------------- ### PowerShell Hash Table Example with System.ServiceProcess Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Illustrates a PowerShell hash table example that includes a reference to `System.ServiceProcess.Servi... Running`. This might be used in contexts where service management is being discussed. ```PowerShell # System.ServiceProcess.Servi... Running ``` -------------------------------- ### Install hunspell-reader as a Library Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/hunspell-reader/README.md Install the hunspell-reader library for use in your Node.js or Typescript projects. ```bash npm install hunspell-reader ``` -------------------------------- ### Install cspell-tools Globally Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-tools-alias/README.md Install the cspell-tools package globally to use its command-line interface. ```sh npm install -g cspell-tools ``` -------------------------------- ### Custom Dictionaries Configuration Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/index.mdx This example shows how to configure custom dictionaries, including loading words from local files and remote URLs. It also demonstrates how to include these custom dictionaries alongside the default language dictionary. ```javascript "language": "en", // Dictionaries "spanish", "ruby", and "corp-terms" will always be checked. // Including "spanish" in the list of dictionaries means both Spanish and English // words will be considered correct. "dictionaries": ["spanish", "ruby", "corp-terms", "fonts"], // Define each dictionary: // - Relative paths are relative to the config file. // - URLs will be retrieved via HTTP GET "dictionaryDefinitions": [ { "name": "spanish", "path": "./spanish-words.txt"}, { "name": "ruby", "path": "./ruby.txt"}, { "name": "corp-terms", "path": "https://shared-company-repository/cspell-terms.txt" } ] ``` -------------------------------- ### PowerShell Mathematical Operation Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Provides an example of a mathematical operation using PowerShell. ```powershell $hypot = [Math]::Sqrt(3*3 ``` -------------------------------- ### Python Zlib Compression/Decompression Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/RustPython/RustPython/snapshot.txt Illustrates handling compressed data, potentially with specific encoding like UTF-8, and shows a snippet of compressed data. ```python "Lorem ipsum dolor sit amet", "utf-8") ``` ```python "xffLorem ipsum dolor sit amet\x83\xd5\t\xc5", ``` -------------------------------- ### SQL Server sp_MSforeachdb Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/ktaranov/sqlserver-kit/snapshot.txt Executes a command for each database using sp_MSforeachdb. Useful for performing database-wide operations or checks. ```sql -- EXEC sp_MSforeachdb N'Use [?]; ``` -------------------------------- ### Enter-PSHostProcess Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt An example of entering a PowerShell host process, showing the process ID and a debug message. This is typically used for debugging or advanced session management. ```powershell [Process: 1520]: [RSDBG: 4]: PS C:\> ``` -------------------------------- ### No Eval Rule Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/eslint/eslint/snapshot.txt Shows an example of using `globalThis.eval` which is disallowed by the 'no-eval' rule. ```javascript code: "globalThis.noneval('foo')" ``` -------------------------------- ### Get-FileHash Package URL Example Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt Demonstrates how to use a package URL with Get-FileHash. This is useful for hashing files from remote sources like GitHub. ```powershell $pkgurl = 'https://github.com ``` ```powershell InputStream ($wc.OpenRead($pkgurl)) ``` -------------------------------- ### Get Zip Comment Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/php/php-src/snapshot.txt Internal function to get the zip comment from a zip object. ```c static char * php_zipobj_get_zip_comment(ze_zip_object ``` -------------------------------- ### Knuth-Morris-Pratt (KMP) Algorithm Examples Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/TheAlgorithms/Python/snapshot.txt Illustrates pattern searching using the KMP algorithm with different texts and patterns. ```Python pattern = "aabaabaaa" text1 = "alskfjaldsabc1abc1abc12k23adsfabcabc" text2 = "alskfjaldsk23adsfabcabc" pattern = "ABABX" text = "ABABZABABYABABX" pattern = "AAAB" text = "ABAAAAAB" pattern = "abcdabcy" text = "abcxabcdabxabcdabcdabcy" ``` -------------------------------- ### Install cspell Globally Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md Install the cspell command-line tool globally using npm or yarn. ```sh npm install -g cspell ```