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

@nokkel/typescript

v1.0.0

Published

A typescript styling guide

Downloads

652

Readme

Nokkel Typescript Styling Guide

This styling guide provide configuration and rules for typescript, eslint and prettier that can be used in Nokkel projects to ensure they meet these recommended stylistic choices. It does not inform code quality, merely the look of how code should be written to ensure it is consistent and easy to interpret for developers.

Using this style guide in your project

In order to use this guide you should first install the following dependencies in your project

npm add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-cypress eslint-plugin-jest eslint-plugin-node eslint-plugin-prettier eslint-plugin-simple-import-sort prettier prettier-eslint typescript typescript-eslint

Then install this package to your project

npm add -D @nokkel/typescript

Then you can add the following files to your Typescript project

.eslintrc.json

{
  "extends": "./node_modules/@nokkel/typescript/.eslintrc.json"
  // Add any overrides/extensions here...
}

OR

eslint.config.js

// eslint.config.js
import myconfig from '@nokkel/typescript/eslint.config.mjs';

export default [...myconfig];

To override: https://eslint.org/docs/latest/extend/shareable-configs#overriding-settings-from-shareable-configs

.prettierrc.js

module.exports = {
  ...require('@nokkel/typescript/.prettierrc.json')
  // And any overrides/extensions here...
};

We also recommend adding the following

.eslintignore

dist/

tsconfig.browser.json

This is an example of a typescript configuration you can put into your browser project that extends the typescript configuration of this library.

{
  "extends": "./node_modules/@nokkel/typescript/tsconfig.browser.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "dist",
    "paths": {
      "@/*": ["src/*"]
    }
    // Add any overrides/extensions here...
  }
}

tsconfig.json

This is an example of a typescript configuration you can put into your project that extends the typescript configuration of this library.

{
  "extends": "./node_modules/@nokkel/typescript/tsconfig.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "dist",
    "paths": {
      "@/*": ["src/*"]
    }
    // Add any overrides/extensions here...
  }
}

Enjoy!