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

@akashic/resurveil

v1.0.0

Published

A tool to surveil and detect content in the target files

Downloads

6

Readme

resurveil

resurveil は、対象ファイルの内容を監査してルールと一致する文言を検出するツールです。

Usage

resurveil [options] file1.txt file2.html file3.md ....

後述する検閲ルールと一致する内容が指定ファイル内に含まれていた場合、1 以上の exit code を返します。

Arguments

検閲するファイル。

Option

| オプション | 短縮名 | 概要 | | -------------------- | ------ | ------------------------------------------------------ | | --config <string> | -c | 設定ファイルのパス | | --ignore-no-config | | 設定ファイルが見つからない場合にエラーとすべきかどうか |

Configuration

Specification

| キー名 | 形式 | 概要 | | ------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------- | | rules | Object | ファイル種別ごとの検閲ルール。 | | rules."pattern" | String | micromatch を使ったパターン。このパターンと一致したファイル名を検閲の対象とする。 | | rules."pattern".deny | Array | 検閲のルール。 | | rules."pattern".deny[] | String \| RegExp | 検閲する文字列・正規表現。このルールが指定のファイル名の内容に含まれていた場合はリジェクトする。 | | rules."pattern".allow | Array | 検閲から除外するルール。 | | rules."pattern".allow[] | String \| RegExp | 検閲から除外する文字列・正規表現。"pattern".deny に該当した場合、このルールに一致した場合は例外的にリジェクトを取り消す。 |

Example

export default {
  rules: {
    "*.html": {
      deny: ["your.company.com"],
      allow: [/(?:www|public)\.your\.company\.com/],
    },
  },
};

Configuration Path

--config オプションを省略した場合、以下の優先度で設定ファイルを検索します。 設定ファイルが見つからなかった場合は 1 以上の exit code を返します。 (ただし --ignore-no-config を指定した場合は 0 の exit code を返します)

  1. <pwd>/resurveilrc.<ext>
  2. <pwd>/resurveil-config.<ext>
  3. $HOME/resurveilrc.<ext>
  4. $HOME/resurveil-config.<ext>

<ext> は以下の順番で優先されます。

  1. js
  2. cjs
  3. mjs

Developers

Install

Node.js が必要です。次のコマンドでインストールできます。

npm i

Build

npm run build

License

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。