fix: rebrand to verdaccio-install-counts to avoid npm rejection

Author: favoyang

CHANGELOG.md

@@ -3,19 +3,19 @@
 
 ### Bug Fixes
 
-* **CI:** set semantic_version to v19 for cycjimmy/semantic-release-action@v2 ([424d330](https://github.com/openupm/verdaccio-download-counts/commit/424d330cd1373414fe8a24c1e381bd4d450b894a))
-* handle the key not exist error for getPackageDownloadTimeSeriesResults() ([62ebb20](https://github.com/openupm/verdaccio-download-counts/commit/62ebb208ff1114019953da578c1fcd27e045d6bf))
-* import-logs scripts ([64de4e6](https://github.com/openupm/verdaccio-download-counts/commit/64de4e6d6e7fb6fe47b1820ab8dd8dba4b23d38a))
-* parseVersionFromTarballFilename for tarball name with multiple hyphens ([01330b7](https://github.com/openupm/verdaccio-download-counts/commit/01330b753695f25ca640f8a0c7a6ae35b2687f49))
-* repository address of package.json ([58ec568](https://github.com/openupm/verdaccio-download-counts/commit/58ec56833e542af15e89c12aff1517e94ce17845))
-* reset-redis.sh will remove pkghit:ver:* ([b133643](https://github.com/openupm/verdaccio-download-counts/commit/b133643da8d070671ecf9b0bcc0f557fd9695fcc))
-* set LICENSE ([2bb55ea](https://github.com/openupm/verdaccio-download-counts/commit/2bb55ea9a5b084d22fb2a447a75b2023d00ed365))
-* should not increase counter for HTTP HEAD ([4dc8d5e](https://github.com/openupm/verdaccio-download-counts/commit/4dc8d5ec0646cf4255d8943552bc6a796df8d53c))
-* update CI npm automation branch ([00aa0d6](https://github.com/openupm/verdaccio-download-counts/commit/00aa0d62dcbd2af5e5837c1ebba5d961f79743c9))
+* **CI:** set semantic_version to v19 for cycjimmy/semantic-release-action@v2 ([424d330](https://github.com/openupm/verdaccio-install-counts/commit/424d330cd1373414fe8a24c1e381bd4d450b894a))
+* handle the key not exist error for getPackageDownloadTimeSeriesResults() ([62ebb20](https://github.com/openupm/verdaccio-install-counts/commit/62ebb208ff1114019953da578c1fcd27e045d6bf))
+* import-logs scripts ([64de4e6](https://github.com/openupm/verdaccio-install-counts/commit/64de4e6d6e7fb6fe47b1820ab8dd8dba4b23d38a))
+* parseVersionFromTarballFilename for tarball name with multiple hyphens ([01330b7](https://github.com/openupm/verdaccio-install-counts/commit/01330b753695f25ca640f8a0c7a6ae35b2687f49))
+* repository address of package.json ([58ec568](https://github.com/openupm/verdaccio-install-counts/commit/58ec56833e542af15e89c12aff1517e94ce17845))
+* reset-redis.sh will remove pkghit:ver:* ([b133643](https://github.com/openupm/verdaccio-install-counts/commit/b133643da8d070671ecf9b0bcc0f557fd9695fcc))
+* set LICENSE ([2bb55ea](https://github.com/openupm/verdaccio-install-counts/commit/2bb55ea9a5b084d22fb2a447a75b2023d00ed365))
+* should not increase counter for HTTP HEAD ([4dc8d5e](https://github.com/openupm/verdaccio-install-counts/commit/4dc8d5ec0646cf4255d8943552bc6a796df8d53c))
+* update CI npm automation branch ([00aa0d6](https://github.com/openupm/verdaccio-install-counts/commit/00aa0d62dcbd2af5e5837c1ebba5d961f79743c9))
 
 
 ### Features
 
-* add npm automation ([61c8645](https://github.com/openupm/verdaccio-download-counts/commit/61c8645c6d6fb51ea48e6c3a162c8e3126b4d255))
-* add the middleware skeleton ([75bdcfb](https://github.com/openupm/verdaccio-download-counts/commit/75bdcfb41aae0a0104dd69ae01424f72fab5873a))
-* script to import nginx server access log as history data ([14d23a1](https://github.com/openupm/verdaccio-download-counts/commit/14d23a101c29668e7b4c1a86ccce58bbcf045ecb))
+* add npm automation ([61c8645](https://github.com/openupm/verdaccio-install-counts/commit/61c8645c6d6fb51ea48e6c3a162c8e3126b4d255))
+* add the middleware skeleton ([75bdcfb](https://github.com/openupm/verdaccio-install-counts/commit/75bdcfb41aae0a0104dd69ae01424f72fab5873a))
+* script to import nginx server access log as history data ([14d23a1](https://github.com/openupm/verdaccio-install-counts/commit/14d23a101c29668e7b4c1a86ccce58bbcf045ecb))

README.md

@@ -1,4 +1,4 @@
-# verdaccio-download-counts
+# verdaccio-install-counts
 
 <!-- vscode-markdown-toc -->
 * [Introduction](#Introduction)
@@ -24,7 +24,7 @@
 
 ## <a name='Introduction'></a>Introduction
 
-This package implements API endpoints for download counts similar to [the ones](https://raw.githubusercontent.com/npm/registry/master/docs/download-counts.md) provided by npm, but limited to a specific package.
+This package implements API endpoints for package download counts similar to [the ones](https://raw.githubusercontent.com/npm/registry/master/docs/install-counts.md) provided by npm, but limited to a specific package.
 
 The stats data is stored in Redis, using [RedisTimeSeries](https://redis.io/docs/stack/timeseries/). Please refer to the [Redis data structure](#redis-data-structure) section for more information.
 
@@ -34,13 +34,13 @@ Note that this package does not include a widget for the Verdaccio web UI.
 
 Install the package.
 ```
-npm install verdaccio-download-counts
+npm install verdaccio-install-counts
 ```
 
 Update the `middlewares` seciton of verdaccio's `config.yaml`.
 ```
 middlewares:
-  download-counts:
+  install-counts:
     enabled: true
     redis:
       host: 127.0.0.1

package-lock.json

@@ -1,5 +1,5 @@
 {
-  "name": "verdaccio-download-counts",
+  "name": "verdaccio-install-counts",
   "version": "1.0.0",
   "description": "The package provides public api that gives you download counts by package and time range.",
   "main": "lib/src/index.js",
@@ -34,11 +34,12 @@
   "keywords": [
     "verdaccio",
     "download counts",
+    "install counts",
     "stats",
     "statistics"
   ],
   "license": "BSD-3-Clause",
-  "repository": "openupm/verdaccio-download-counts",
+  "repository": "openupm/verdaccio-install-counts",
   "author": "Favo Yang <https://github.com/favoyang>",
   "scripts": {
     "build": "tsc",

package.json

@@ -37,7 +37,7 @@ export function readVerdaccioConfig(): any {
 export function createRedisClient(): Redis {
   const verdaccioConfig = readVerdaccioConfig();
   const middlewares = verdaccioConfig['middlewares']
-  const downloadCounts = middlewares['download-counts'];
+  const downloadCounts = middlewares['install-counts'];
   let redisOptions = {};
   if ('redis' in downloadCounts)
     redisOptions = downloadCounts['redis'];

src/bin/cli-utils.ts

@@ -60,14 +60,14 @@ export default class VerdaccioMiddlewarePlugin implements IPluginMiddleware<Cust
       const { period, package: packageName } = req.params;
       try {
         const [startDate, endDate] = parsePeriod(period);
-        // this.logger.debug(`[download-counts] startDate: ${startDate.toISOString()}, endDate: ${endDate.toISOString()}`);
+        // this.logger.debug(`[install-counts] startDate: ${startDate.toISOString()}, endDate: ${endDate.toISOString()}`);
         const metadata = await getPackageAsync(_storage, {
           name: packageName,
           uplinksLook: true,
           req,
           abbreviated: false
         });
-        // this.logger.debug(`[download-counts] metadata: ${JSON.stringify(metadata)}`);
+        // this.logger.debug(`[install-counts] metadata: ${JSON.stringify(metadata)}`);
         const results = await getPackageDownloadTimeSeriesResults(self.redisClient, startDate, endDate, packageName);
         let totalDownloads = 0;
         if (results !== null) {
@@ -100,14 +100,14 @@ export default class VerdaccioMiddlewarePlugin implements IPluginMiddleware<Cust
       const { period, package: packageName } = req.params;
       try {
         const [startDate, endDate] = parsePeriod(period);
-        // this.logger.debug(`[download-counts] startDate: ${startDate.toISOString()}, endDate: ${endDate.toISOString()}`);
+        // this.logger.debug(`[install-counts] startDate: ${startDate.toISOString()}, endDate: ${endDate.toISOString()}`);
         const metadata = await getPackageAsync(_storage, {
           name: packageName,
           uplinksLook: true,
           req,
           abbreviated: false
         });
-        // this.logger.debug(`[download-counts] metadata: ${JSON.stringify(metadata)}`);
+        // this.logger.debug(`[install-counts] metadata: ${JSON.stringify(metadata)}`);
         const results = await getPackageDownloadTimeSeriesResults(self.redisClient, startDate, endDate, packageName);
         const downloads: { day: string; downloads: number }[] = [];
         if (results !== null) {

src/index.ts

@@ -61,29 +61,29 @@ export function getVersion(pkg: Package, version: any): Version | void {
 export function redisCreateClient(config: string | RedisOptions, logger: Logger): Redis {
   const client = new Redis(config as any);
   client.on('connect', function () {
-    logger.warn('[download-counts] connected to redis server');
+    logger.warn('[install-counts] connected to redis server');
   });
 
   client.on("ready", function () {
-    logger.warn("[download-counts] ready to use");
-    logger.warn("[download-counts] set enableOfflineQueue to false to make following web requests fail instantly when redis connection is down");
+    logger.warn("[install-counts] ready to use");
+    logger.warn("[install-counts] set enableOfflineQueue to false to make following web requests fail instantly when redis connection is down");
     client.options.enableOfflineQueue = false;
   });
 
   client.on('reconnecting', function (delay) {
-    logger.warn({ delay }, '[download-counts] reconnecting in @{delay}ms');
+    logger.warn({ delay }, '[install-counts] reconnecting in @{delay}ms');
   });
 
   client.on('end', function () {
-    logger.warn('[download-counts] redis connection end');
+    logger.warn('[install-counts] redis connection end');
   });
 
   client.on('close', function () {
-    logger.warn('[download-counts] redis connection close');
+    logger.warn('[install-counts] redis connection close');
   });
 
   client.on('error', function (err) {
-    logger.error({ err }, '[download-counts] redis error @{err}');
+    logger.error({ err }, '[install-counts] redis error @{err}');
   });
 
   return client;
@@ -226,8 +226,8 @@ export function parsePeriod(period: string): Array<Date> {
   // Make sure that startDate is before endDate
   if (startDate > endDate)
     endDate = startDate;
-  // self.logger.debug(`[download-counts] startDate: ${startDate.toISOString()}`);
-  // self.logger.debug(`[download-counts] endDate: ${endDate.toISOString()}`);
+  // self.logger.debug(`[install-counts] startDate: ${startDate.toISOString()}`);
+  // self.logger.debug(`[install-counts] endDate: ${endDate.toISOString()}`);
   return [startDate, endDate];
 }