@softmedialab/24feb

@softmedialab/24feb

Поиск токсичных пакетов 'https://raw.githubusercontent.com/stravnik/toxic-repos/main/data/json/toxic-repos.json' и указанных символов

1) Установите

$ npm install @softmedialab/24feb

$ yarn add @softmedialab/24feb

При необходимости пакет можно установить глобально (добавим соответствующие флаги)

$ npm install -g @softmedialab/24feb

$ yarn global add @softmedialab/24feb

2) Настройте конфигурацию (опционально)

Для настройки необходимо в папке проекта (там где package.json) разместить файл config24feb.json

Если файла нет, то будут использованы базовые настройки:

{
  "rootDir": "node_modules/**",
  "charsForCheck": [
    {
      "char": "🇷🇺",
      "desc": "flag_RU"
    },
    {
      "char": "🇺🇦",
      "desc": "flag_UKR"
    }
  ],
  "ignorePatterns": [],
  "extraPaths": [],
  "throwIfFound": true
}

По настройке символов ("charsForCheck"):

Символы, такие как emoji, могут не отображаться в консоли должным образом. Некоторые операционные системы не поддерживают вывод символов из Unicode, а некоторые требуют установки дополнительных пакетов. Если вы уверены, что ваша ОС поддерживает специальные символы, такие как "🇷🇺", тогда в "desc" также можно указать "🇷🇺"

Пример дополнительных полей и настроек при создании config24feb.json

{
  "rootDir": "node_modules/**",
  "charsForCheck": [
    {
      "char": "🇷🇺",
      "desc": "🇷🇺"
    },
    {
      "char": "🇺🇦",
      "desc": "flag_UKR"
    }
  ],
  "ignorePatterns": ["node_modules/es5-ext/_postinstall.js"],
  "extraPaths": ["src/**"],
  "throwIfFound": true
}

3) Запустите сканирование

Если пакет был установлен не глобально тогда необходимо, в package.json проекта добавить

  "scripts": {
    "24feb": "24feb run",
  },

После этого в терминале выполнить команды

$ npm run 24feb

или (в зависимости от используемого установщика пакетов)

$ yarn 24feb

Если пакет был установлен глобально тогда достаточно выполнить команду

24feb run