Skip to content

Commit

Permalink
docs: Add CommonJS example (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdjermanovic committed Aug 28, 2024
1 parent d678477 commit bc7c371
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,47 @@ export default [
];
```

In CommonJS format:

```js
const json = require("@eslint/json").default;

module.exports = [
{
plugins: {
json,
},
},

// lint JSON files
{
files: ["**/*.json"],
language: "json/json",
rules: {
"json/no-duplicate-keys": "error",
},
},

// lint JSONC files
{
files: ["**/*.jsonc", ".vscode/*.json"],
language: "json/jsonc",
rules: {
"json/no-duplicate-keys": "error",
},
},

// lint JSON5 files
{
files: ["**/*.json5"],
language: "json/json5",
rules: {
"json/no-duplicate-keys": "error",
},
},
];
```

## Recommended Configuration

To use the recommended configuration for this plugin, specify your matching `files` and then use the `json.configs.recommended` object, like this:
Expand Down

0 comments on commit bc7c371

Please sign in to comment.