https://github.com/movahhedi/cspell-define-config

https://github.com/movahhedi/cspell-define-config

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/movahhedi/cspell-define-config
• Owner: movahhedi
• Created: 2024-03-09T08:47:30.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-09T08:47:32.000Z (10 months ago)
• Last Synced: 2024-12-10T00:37:14.670Z (about 1 month ago)
• Language: TypeScript
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cspell-define-config

Provides a simple `defineConfig()` function to ease the creation of `cspell.config.js` files for spell checking in your projects.

## Installation

You can install `cspell-define-config` using npm:

```bash

npm install -D cspell-define-config

```

## Usage

Here's a basic example of how to use `defineConfig()`:

```javascript

import { defineConfig } from "cspell-define-config";

export default defineConfig({

	version: "0.2",

	ignorePaths: ["node_modules/**", "**/vendor/**", "temp/**", "dist/**", "build/**"],

	minWordLength: 4,

	allowCompoundWords: true,

	words: [],

	ignoreWords: [],

	import: [],

});

```

## License

This project is licensed under the MIT License.