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

@openameba/textlint-rule-preset-ameba

v0.5.1

Published

textlint rule preset for Ameba

Downloads

1,392

Readme

textlint-rule-preset-ameba test

Amebaで利用するtextlintルールプリセットです。以下の目的で利用しています。

  • 表記ゆれを修正するため
  • わかりやすい日本語にするため
  • 複数人により書かれた文章を、統一された基準で校正するため

ルールの詳細は設定ファイルをご覧ください。

Installation

npm install --save-dev @openameba/textlint-rule-preset-ameba

or

yarn add --dev @openameba/textlint-rule-preset-ameba

Usage

CLI、Node module、エディタ内など様々な方法で利用できます。利用方法の詳細はtextlintをご覧ください。

.textlintrc

{
  "rules": {
    "@openameba/preset-ameba": true
  }
}

Allow List

Release v0.5.0よりAmebaのVisionにある「つくる、つむぐ、つづく、」が追加されました。 textlintでは読点の最大数を設定しており、バリデーションから除外すること推奨しています。

利用者側で下記のように.textlintrcを拡張してください。

{
  "rules": {},
  "filters": {
    "allowlist": {
      "allowlistConfigPaths": [
        "./node_modules/@openameba/textlint-rule-preset-ameba/lib/allow-ameba.yml"
      ]
    }
  }
}

Release

  1. リリース対象の成果物を main ブランチにマージします
  2. GitHub Actionsのversioning
    1. 「Run workflow」からアップデートするバージョンを記載のジョブを実行
    2. package.jsonのversionがアップデートされ自動的にPull requestが作成されます
    3. バージョンアップのPull requestを main ブランチにマージ
  3. GitHub Actionsのpublishより「dry run」にチェックを入れた状態でジョブを実行
  4. 「dry run」のジョブが成功したら「dry run」のチェックボックスを外してジョブを実行
  5. リリースが完了したらReleasesの「Draft a new release」からリリースノートを作成しましょう
    1. 対象のリリースバージョンを選択後、「Generate release notes」ボタンを押して「Publish release」します
  6. リリース作業完了となります