@cspell/dict-makefile

What is @cspell/dict-makefile?

@cspell/dict-makefile is a dictionary extension for the CSpell spell checker that provides support for Makefile-specific terminology. It helps developers ensure that their Makefile scripts are free from spelling errors by recognizing and validating common terms used in Makefiles.

What are @cspell/dict-makefile's main functionalities?

Makefile Terminology Support

This feature allows CSpell to recognize and validate Makefile-specific terms. The code sample demonstrates how to configure CSpell to use the Makefile dictionary and validate a simple Makefile script.

const cspell = require('cspell');
const settings = {
  language: 'en',
  dictionaries: ['makefile'],
};

const text = 'all: build\n\t@echo Building project...';
const result = cspell.validateText(text, settings);
console.log(result);

Other packages similar to @cspell/dict-makefile

@cspell/dict-python

@cspell/dict-python is a dictionary extension for CSpell that provides support for Python-specific terminology. Similar to @cspell/dict-makefile, it helps developers ensure that their Python code is free from spelling errors by recognizing and validating common Python terms.

@cspell/dict-html

@cspell/dict-html is a dictionary extension for CSpell that provides support for HTML-specific terminology. It helps developers ensure that their HTML documents are free from spelling errors by recognizing and validating common HTML terms, similar to how @cspell/dict-makefile works for Makefiles.

README

CSpell Makefile Dictionary

Makefile dictionary for cspell.

This is a pre-built dictionary for use with CSpell.

Requirements

Tool	Version
cspell	>= 8
Code Spell Checker - Visual Studio Code	>= 4

Local Installation

This package is bundled with CSpell.

Configuration

VSCode Settings

Add the following to your VSCode settings:

.vscode/settings.json

{
  "cSpell.dictionaries": ["makefile"],
}

CSpell Settings `cspell.json`

cspell.json

{
  "dictionaries": ["makefile"],
}

CSpell Settings `cspell.config.yaml`

cspell.config.yaml

dictionaries:
  - makefile

[!NOTE] This package is bundled with CSpell.

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

Special thanks to all of our amazing contributors!

Dictionary Development

See: How to Create a New Dictionary

License

MIT

Some packages may have other licenses included.

Brought to you by Street Side Software