npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kitschpatrol/remark-config

v4.7.12

Published

Markdown and MDX linting for @kitschpatrol/shared-config.

Downloads

146

Readme

@kitschpatrol/remark-config

NPM Package @kitschpatrol/remark-config License: MIT

Markdown and MDX linting for @kitschpatrol/shared-config.

Overview

It's a shared Remark config for linting.

See @kitschpatrol/shared-config for the recommended single-package approach.

Setup

To use just this Remark config in isolation:

  1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

    pnpm dlx @kitschpatrol/repo-config --init
  2. Add the package:

    pnpm add -D @kitschpatrol/remark-config
  3. Add the starter .remarkrc.js and files to your project root, and add any customizations you'd like:

    pnpm exec remark-config --init

Usage

The Remark binary should be picked up automatically by VS Code plugins.

You can call it directly, but it's recommended to use the script bundled with the shared config to invoke the remark lint rules through ESLint. The eslint-mdx plugin is used to bridge these rules into ESLint and the VS Code ESLint plugin.

Integrate with your package.json scripts as you see fit, for example:

"scripts": {
  "lint": "pnpm remark . --quiet --frail"
}

CLI

Command: remark-config

Markdown and MDX linting for @kitschpatrol/shared-config.

Usage:

remark-config [<file|glob> ...]

| Option | Argument | Description | | ------------------------ | -------- | ---------------------------------------------------------------- | | --init-i | | Initialize by copying starter config files to your project root. | | --print-config-p | <path> | Print the effective configuration at a certain path. | | --help-h | | Print this help info. | | --version-v | | Print the package version. |

Configuration

Avoiding errors in non-git projects

The remark-validate-links looks for a git remote to validate relative link paths.

If your project is not a git repository, you will receive warning from remark via eslint:

Command failed: git remote -v
fatal: not a git repository (or any of the parent directories): .git
eslint(undefined-undefined)

To fix this, pass the repository: false option in your .remarkrc.js file:

// .remarkrc.js
import sharedConfig, { overrideRules } from '@kitschpatrol/remark-config'

const localConfig = {
  ...sharedConfig,
  plugins: overrideRules(sharedConfig.plugins, [['remarkValidateLinks', { repository: false }]]),
}

export default localConfig

License

MIT © Eric Mika