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

@nodutilus/project-config

v2.0.2

Published

Node.js utilities - projects shared configuration

Downloads

14

Readme

nodutilus project config

Node.js utilities - projects shared configuration

Установка:

$ npm i @nodutilus/project-config --save-dev

Справка:

$ npx nodutilus help

Запустить все проверки:

$ npx nodutilus all

Пример настройки GitHub Actions из nodutilus/project-config:

name: Checks ➜ Tests ➜ Publish

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

jobs:
  main:
    uses: nodutilus/project-actions/.github/workflows/main.yml@main
    with:
      eslint: true
      eslintcc: true
      types: true
      tests: true
      coverage: true
      publish: true
      publish_branche: main
    secrets:
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

ESLint

Конфиг для статического анализа модулей в формате ESM при помощи утилиты eslint.

Правила по умолчанию

Настройки

.eslintrc.json:

{
  "extends": "@nodutilus"
}

Использование

Локально

$ npx nodutilus eslint

GitHub Actions

name: Checks
jobs:
  checks:
    steps:
      - uses: npx nodutilus eslint

ESLintCC

Для оценки сложности кода используется модуль: eslintcc. На странице модуля есть описание настроек и критериев оценки.

Для работы модуль использует настройки ESLint текущего проекта.

Использование

Локально

$ npx nodutilus eslintcc

GitHub Actions

name: Checks
jobs:
  checks:
    steps:
      - uses: npx nodutilus eslintcc

Type Checking JavaScript

Проверка типов в коде написанном на JavaScript при помощи TypeScript

Подробнее о проверке типов в см. статье: JS Projects Utilizing TypeScript

Настройки

tsconfig.json:

{
  "extends": "@nodutilus/project-config/tsconfig"
}

Использование

Локально

$ npx nodutilus ts-check

GitHub Actions

name: Checks
jobs:
  checks:
    steps:
      - uses: npx nodutilus ts-check

Run tests

Для запуска тестов используется команда node test или npm run test (если настроен скрипт в package.json). Так же можно настроить пред- и пост- обработчик запуска тестов скриптами npm run pre-test и npm run post-test

Настройки

package.json:

{
  "scripts": {
    "pre-test": "node test/pre-test",
    "test": "node test/index",
    "post-test": "node test/post-test"
  }
}

Использование

Локально

$ npx nodutilus test

GitHub Actions

name: Tests
jobs:
  tests:
    steps:
      - uses: npx nodutilus test

Code coverage with c8

Покрытие кода с использованием встроенных функций Node.js. Для настройки используется конфигурация nyc

Для оценки покрытия запускается сценарии аналогичные описанным в разделе Run tests (Покрытие оценивается только для сценария запуска тестов)

Настройки

.nycrc.json:

{
  "extends": "@nodutilus/project-config/nyc"
}

Использование

Локально

$ npx nodutilus c8

GitHub Actions

name: Coverage
jobs:
  coverage:
    steps:
      - uses: npx nodutilus c8