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

@maarkllc/code-config

v2.1.0

Published

Collection of configurations to enforce consistent development guidelines using Maark's recommendations.

Downloads

377

Readme

Code configurations

badge badge-ci

Collection of configurations to enforce consistent development guidelines using Maark's recommendations.

To install a new configuration you can either use the CLI to handle everything automatically or do it manually.

Using the CLI with npx

npx @maarkllc/code-config

This will guide you through a few steps that will ultimately install the desired configuration. That's it, happy coding!

Installing the CLI globally

Alternatively, you can install the code-config CLI globally and use it like so:

npm i -g @maarkllc/code-config

code-config

Available commands

If you want to skip the first step you can pass the command as a parameter. This is optional because if you don't pass anything, the CLI will ask you what you want to execute.

code-config [command]
  • eslint To install an ESLint configuration.
  • stylelint To install a Stylelint configuration.
  • githook To install a ESLint and Stylelint Git Hook commands.
  • help Shows the help screen.

e.g.

code-config eslint

// or

npx @maarkllc/code-config stylelint

Installing configurations manually

All configurations are inside the configs/ folder, categorized by tool. Each tool explains how to install it manually.

Supported configurations

The idea is to have a structure of configurations that extend from each other as needed depending on the project stack, it is important to define rules to be able to identify anti-patterns and code-smells for specific known libraries. This diagram helps illustrate the possible configurations and how it can scale in the future to include other tools of trade for bundling or unit testing:

%%{init: {'theme':'base'}}%%
graph TD
    subgraph Legend
        L1[Available]:::available --> L2[Not ready]
    end

    A[ESLint]:::available --> B[JavaScript]:::available
    B --> C[js/base]:::available
    C --> D[js/react]:::available
    C --> js/vue
    C --> js/angular
    D --> js/next

    A --> E[Typescript]

    F[Stylelint]:::available --> G[CSS]:::available
    F --> H[SCSS]:::available
    G --> css/base:::available
    H --> scss/base:::available

    Webpack

    classDef available stroke:#0B410E,fill:#94D1BE

ESLint

  • js/base: It extends from Airbnb base configuration.
  • js/react: It extends from js/base and Airbnb full configuration and hooks rules.

Stylelint

  • css/base: It extends from stylelint-config-standard.
  • scss/base: It extends from css/base and stylelint-config-standard-scss.

GitHook

Multi select (choose with spacebar one or more) between:

  • eslint: to add hook to validate eslint.
  • stylelint: to add hook to validate Stylelint.

Development

For more information please refer to the documentation.