Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
remark-lint-no-file-name-irregular-characters
Advanced tools
remark-lint rule to warn when file names contain irregular characters
remark-lint
rule to warn when file names contain irregular characters.
This package checks file names.
You can use this package to check that file names are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-file-name-irregular-characters
In Deno with esm.sh
:
import remarkLintNoFileNameIrregularCharacters from 'https://esm.sh/remark-lint-no-file-name-irregular-characters@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoFileNameIrregularCharacters from 'https://esm.sh/remark-lint-no-file-name-irregular-characters@3?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoFileNameIrregularCharacters from 'remark-lint-no-file-name-irregular-characters'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoFileNameIrregularCharacters)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-file-name-irregular-characters .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-file-name-irregular-characters",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoFileNameIrregularCharacters
.
unified().use(remarkLintNoFileNameIrregularCharacters[, options])
Warn when file names contain contain irregular characters.
options
(RegExp
or string
, default: /[^-.\dA-Za-z]/
)
— configuration,
when string wrapped in new RegExp('[^' + x + ']')
so make sure
to escape regexp charactersTransform (Transformer
from unified
).
mercury-and-venus.md
No messages.
mercury.md
No messages.
mercury_and_venus.md
1:1: Unexpected character `_` in file name
Readme.md
When configured with '\\.a-z0-9'
.
1:1: Unexpected character `R` in file name
mercury_and_venus.md
When configured with { source: '[^\\.a-z0-9]' }
.
1:1: Unexpected character `_` in file name
mercury and venus.md
1:1: Unexpected character ` ` in file name
not-ok-options.md
When configured with 1
.
1:1: Unexpected value `1` for `options`, expected `RegExp` or `string`
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-no-file-name-irregular-characters@3
,
compatible with Node.js 16.
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark-lint rule to warn when file names contain irregular characters
The npm package remark-lint-no-file-name-irregular-characters receives a total of 64,615 weekly downloads. As such, remark-lint-no-file-name-irregular-characters popularity was classified as popular.
We found that remark-lint-no-file-name-irregular-characters demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.