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

@gkd-kit/test

v0.0.2

Published

GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 [Use this template](https://github.com/new?template_name=subscription-template&template_owner=gkd-kit) 即可使用

Downloads

3

Readme

subscription-template

GKD 订阅模板, 此仓库方便您直接构建自己订阅, 点击右上角 Use this template 即可使用

配置环境

请安装最新版 nodejs 和 pnpm 运行, 以及使用 vscode 打开项目

安装好后使用模板, 假设您刚刚使用 Use this template 创建的仓库是 https://github.com/username/subscription

接下来下载并初始化环境

git clone https://github.com/username/subscription
cd subscription
pnpm install

image

至此环境已在 subscription 目录下初始化完毕, 使用 vscode 打开目录即可开始开发

接下来下面所有的示例链接都基于 username/subscription, 请自行替换后打开

pnpm install 用于安装依赖, 如果您的 ./package.json 发生变化, 则需要再次运行 pnpm install


如果您无法初始化 nodejs 环境, 那可以直接使用 github 网页编辑文件后在线提交, 点击下面链接即可在线编辑

https://github.com/username/subscription/edit/main/src/subscription.ts

image

目录结构

在 vscode 内使用鼠标悬浮在任意字段上即可查看注释说明, 也可在 https://gkd.li/api 搜索查看

image

现在您可编辑 ./src 下的文件来自定义您的订阅, 构建后的订阅文件处于 ./dist 目录下

另外您必须修改 订阅详情 ./src/subscription.ts 下的 id 字段, 否则可能会和其它订阅冲突, 填一个较大的随机数字即可

提交规范

我们使用 commitlint 来校验提交信息

它要求提交的标题需要符合规范, 不符合规范的无法提交, 您可以查看它的文档规范你的提交

格式修复

我们使用 prettier 来格式化代码 和 eslint 来检测并修复代码错误

同时使用 simple-git-hooks 在您提交代码时运行格式化和代码检测修复脚本

当您的代码存在错误时, 它会阻止您提交代码并输出具体错误以供您手动修复后再次提交

当提交代码到仓库时, 我们也需要使用 github actions 来帮助自动格式化并修复代码, 因此您需要开启仓库的此项权限

打开 https://github.com/username/subscription/settings/actions

然后找到 Workflow permissions 点击 Read and write permissions 然后点击下方的 Save 即可

image

构建订阅

我们需要将 ./src 分散的文件合并为一个 gkd.json5 的最终订阅文件并输出到 ./dist 目录下

推荐使用 github actions 进行构建, 在 ./.github/workflows 下有 3 个工作流

我们使用其中的 build_release.yml 构建并发布

打开 https://github.com/username/subscription/actions/workflows/build_release.yml

然后点击右侧的 Run workflow 即可运行并发布

image

构建后订阅将输出到 dist 目录下, gkd.json 的文件订阅地址如下, 复制后到 GKD 添加即可

https://raw.githubusercontent.com/username/subscription/main/dist/gkd.json5

镜像加速

raw.githubusercontent.com 在大陆的访问常常无法访问

您可以换成 https://fastly.jsdelivr.net/gh/username/subscription@main/dist/gkd.json5 加速访问

如果无法访问 raw.githubusercontent.com 和 fastly.jsdelivr.net

您可以将本仓库发布到 npm 上, 然后通过 registry.npmmirror.com 加速访问

要发布到 npm 上, 必须先将 ./package.json 的 name 字段改成未使用的包名, 否则发布失败

您可以改成 gkd-subscription-xxxx 其中 xxxx 是订阅的 id 或者随机字母数字, 总之不冲突就行

或者改成 @your_npm_name/subscription, 这种类型是 scope 名称, 其中 your_npm_name 是你下面要注册的 npm 用户名

image

接下来获取 token, 你需要先注册 https://www.npmjs.com, 然后到 Access Tokens 界面点击 Generate New Token 选择 Classic Token 后随便输入 Name 选择 Publish 即可生成并复制

image

image

image

复制后打开 https://github.com/username/subscription/settings/secrets/actions/new

在 Name 输入 NPM_TOKEN, 在 Secret 输入刚刚复制的 token, 点击 Add secret 即可添加成功

image

然后只需要重复上面的 构建订阅 步骤即可发布, 发布后得到的镜像加速链接如下

https://registry.npmmirror.com/gkd-subscription-xxxx/latest/files/dist/gkd.json5

注: 将 gkd-subscription-xxxx 换成您的包名

如果你的包名是 @your_npm_name/subscription 这种类型, 加速链接是

https://registry.npmmirror.com/@your_npm_name/subscription/latest/files/dist/gkd.json5

由于 npmmirror 被恶意刷流量后已经改为白名单模式, 不在白名单内的包, 上面的链接无法正常加速访问

因此要使上面的链接被正常访问, 你需要向 https://github.com/cnpm/unpkg-white-list 提交 pr 将你的包添加到白名单

自定义配置文件

注意: 大多数情况下, 你不需要自定义, 使用默认配置时, 下面此节教程无需了解

你可以在 ./package.json 下添加 gkd 属性配置自定义构建选项

{
  "gkd": {
    "outDir": "dist",
    "file": "gkd.json5",
    "versionFile": "gkd.version.json5",
    "changelog": "CHANGELOG.md",
    "README.md": "README.md"
  }
}

这个 gkd 属性的类型如下

/**
 * @default package.json.gkd
 */
type GkdConfig = {
    /**
     * @default 'dist'
     */
    outDir?: string;
    /**
     * @default 'gkd.json5'
     */
    file?: string;
    /**
     * @default 'gkd.version.json5'
     */
    versionFile?: string;
    /**
     * @default 'CHANGELOG.md'
     */
    changelog?: string;
    /**
     * @default 'README.md'
     */
    readme?: string;
};

如果不想写配置文件, 也可以将这个参数直接传递给 @gkd-kit/toolsupdateDist 函数

手动传递参数的时候, 你必须显式将路径(非文件名)参数传递给 ./.github/workflows/build_release.yml 下的 updatePkgVersionstdoutGkdVersion 函数