docmark-extension-jsonc

docmark extension to support jsonc comment syntax.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • jsonComments
  • jsonBlockComment
  • jsonLineComment
• Types
  • Options
  • Module Augmentations
    • ParseContext
    • Settings
• Project
  • Version
  • Contribute
  • Sponsor

What is this?

TODO: what is this?

When should I use this?

TODO: when should i use this?

Install

This package is ESM only.

In Node.js with yarn:

yarn add @flex-development/docmark-extension-jsonc

See Git - Protocols | Yarn  for details regarding installing from Git.

In Deno with esm.sh:

import { jsonComments } from 'https://esm.sh/@flex-development/docmark-extension-jsonc'

In browsers with esm.sh:

<script type="module">
  import { jsonComments } from 'https://esm.sh/@flex-development/docmark-extension-jsonc'
</script>

Use

TODO: use

API

This package exports the identifiers jsonComments, jsonBlockComment, and jsonLineComment.

The default export is jsonComments.

jsonComments

TODO: jsonComments

jsonBlockComment

TODO: jsonBlockComment

jsonLineComment

TODO: jsonLineComment

Types

This package is fully typed with TypeScript.
It exports additional types.

Options

Extends

• LanguageOptions

Properties

• comments (boolean | null | undefined, optional) — whether comments are allowed
  • default: true
• docs (boolean | null | undefined, optional) — whether docblocks are supported

Module Augmentations

ParseContext

import type {} from '@flex-development/docmark-extension-jsonc/parse-context'

For more info, see ParseContext from @flex-development/docmark-util-types.
New and mutated properties added by this package are documented below.

Properties

• skipComment (boolean | undefined, optional) — whether a comment is not allowed at the current position

Settings

import type {} from '@flex-development/docmark-extension-jsonc/settings'

For more info, see Settings from @flex-development/docmark-util-types.
New and mutated properties added by this package are documented below.

Properties

• json (Options | null | undefined, optional) — json comment parsing options.
  when building docmark extensions, developers should extend Options and re-augment Settings

Project

Version

docmark-extension-jsonc adheres to semver.

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Sponsor

Small primitives power larger systems.
Support long-term stability by sponsoring Flex Development.