Merge pull request #1 from luistak/refactor/pkg-usage

refactor: changed package name to pkg-usage and implemented tests

Author: luistak

.eslintignore

@@ -1,4 +1,5 @@
 dist/
 example/
 coverage/*
-node_modules/
+node_modules/
+__mocks__/

.eslintrc

@@ -3,9 +3,11 @@
   "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint/eslint-plugin"],
   "parserOptions": {
+    "sourceType": "module",
     "project": "./tsconfig.json"
   },
   "env": {
-    "node": true
+    "node": true,
+    "jest": true
   }
 }

.gitignore

@@ -41,6 +41,9 @@ build/Release
 node_modules/
 jspm_packages/
 
+# Mocks directories
+__mocks__/
+
 # TypeScript v1 declaration files
 typings/
 

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 We love pull requests. And following this guidelines will make your pull request easier to merge.
 
-If you want to contribute but don’t know what to do, take a look at these two labels: [help wanted](https://github.com/luistak/npm-package-usage/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/luistak/npm-package-usage/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+If you want to contribute but don’t know what to do, take a look at these two labels: [help wanted](https://github.com/luistak/pkg-usage/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/luistak/pkg-usage/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
 
 _[Use GitHub interface](https://blog.sapegin.me/all/open-source-for-everyone/) for simple documentation changes, otherwise follow the steps below._
 

README.md

@@ -1,16 +1,57 @@
-# WIP: 🏗️ npm-pkg-usage 🚧
+# 📦 pkg-usage
 
-[![npm](https://img.shields.io/npm/v/npm-pkg-usage.svg)](https://www.npmjs.com/package/npm-pkg-usage)
+[![npm](https://img.shields.io/npm/v/pkg-usage.svg)](https://www.npmjs.com/package/pkg-usage)
 
-> ⚠️ This library is under development so feel free to check it out but it's not ready for production.
+## Installation
+
+```sh
+npm install windowed-observable
+
+# or
+
+yarn add windowed-observable
+```
 
 ## Introduction
 
 Have you ever wondered how your library is being used in other repositories? It's your lucky day because this package aims to solve it.
 
-Given a `npm-pkg-usage.yml` file you could configure and gets details about how your library is being imported
+Given a few options you can gets details about how your library is being imported along with its version
+
+## Usage
+
+```js
+import { getPackagesUsages } from 'pkg-usage';
+
+const usages = getPackagesUsages({
+  packages: ['react'],
+  fileGlobs: `**/**.ts`,
+});
+
+console.log(usages);
+```
+
+Output
+
+```json
+[
+  {
+    count: 1,
+    files: [
+      {
+        defaultImport: undefined,
+        name: `${fileName}.ts`,
+        namedImports: imports,
+      },
+    ],
+    name: pkg,
+    version,
+  }
+]
+```
 
-### Current features:
+## Current features:
 
+- The package version
 - How many files are importing your `package`
 - What are the default and named imports by file

__tests__/pkg-usage.test.ts

@@ -0,0 +1,73 @@
+import {
+  MOCKS_DIR,
+  MOCKS_DIR_CWD,
+  mockPackageUsageFile,
+  cleanupMockFiles,
+} from './utils';
+import { getPackagesUsages } from '../src';
+
+afterEach(() => {
+  cleanupMockFiles();
+});
+
+beforeEach(() => {
+  cleanupMockFiles();
+});
+
+describe('getPackagesUsages()', () => {
+  describe('given a wrong file glob', () => {
+    it('should THROW an Error', () => {
+      const { pkg } = mockPackageUsageFile();
+
+      expect(() =>
+        getPackagesUsages({
+          packages: [pkg],
+          fileGlobs: `WRONG_FILE_GLOB/**.xyz`,
+        })
+      ).toThrow();
+    });
+  });
+
+  describe('given a file without import declaration', () => {
+    it('should return a package usage without a single count', () => {
+      const { pkg, version } = mockPackageUsageFile(
+        ` file data without import declaration `
+      );
+
+      expect(
+        getPackagesUsages({
+          packages: [pkg],
+          fileGlobs: `${MOCKS_DIR}/**.ts`,
+          packageJsonCWD: MOCKS_DIR_CWD,
+        })
+      ).toStrictEqual([{ count: 0, files: [], name: pkg, version }]);
+    });
+  });
+
+  describe('given any package name and named imports', () => {
+    it('should return the right package usage', () => {
+      const { fileName, imports, pkg, version } = mockPackageUsageFile();
+
+      expect(
+        getPackagesUsages({
+          packages: [pkg],
+          fileGlobs: `${MOCKS_DIR}/**.ts`,
+          packageJsonCWD: MOCKS_DIR_CWD,
+        })
+      ).toStrictEqual([
+        {
+          count: 1,
+          files: [
+            {
+              defaultImport: undefined,
+              name: `${fileName}.ts`,
+              namedImports: imports,
+            },
+          ],
+          name: pkg,
+          version,
+        },
+      ]);
+    });
+  });
+});

__tests__/utils.ts

@@ -0,0 +1,63 @@
+import { join, dirname } from 'path';
+import { cwd } from 'process';
+import { writeFileSync, existsSync, mkdirSync, rmdirSync } from 'fs';
+import f from 'faker';
+
+export const MOCKS_DIR = '__mocks__';
+export const MOCKS_DIR_CWD = join(join(cwd(), MOCKS_DIR));
+
+function writeFile(fileName: string, data: string) {
+  const path = `${MOCKS_DIR}/${fileName}`;
+
+  if (!existsSync(dirname(path))) {
+    mkdirSync(dirname(path));
+  }
+
+  writeFileSync(join(cwd(), path), data);
+}
+
+export function cleanupMockFiles() {
+  rmdirSync(MOCKS_DIR, { recursive: true });
+}
+
+function mockUniqueList<T, U>(
+  // eslint-disable-next-line no-unused-vars
+  mapFn: (value: T, index: number, array: T[]) => U
+) {
+  return new Array(f.datatype.number({ min: 2, max: 10 }))
+    .fill('')
+    .map(mapFn)
+    .filter((value, index, self) => self.indexOf(value) === index);
+}
+
+export function mockPackageUsageFile(customData?: string) {
+  const imports = mockUniqueList(() => f.hacker.noun().replace(/ |-/g, ''));
+  const fileName = f.datatype.uuid();
+  const pkg = f.hacker.noun();
+  const version = f.system.semver();
+
+  // Mocked with random data to generate a resilient test
+  const data = customData ?? `import { ${imports.join(', ')} } from '${pkg}';`;
+  writeFile(`${fileName}.ts`, data);
+
+  writeFile(
+    'package.json',
+    JSON.stringify({
+      name: 'example',
+      version: '1.0.0',
+      main: 'index.js',
+      author: 'Luis Takahashi',
+      license: 'MIT',
+      dependencies: {
+        [pkg]: version,
+      },
+    })
+  );
+
+  return {
+    imports,
+    fileName,
+    pkg,
+    version,
+  };
+}

example/npm-pkg-usage.yml

@@ -0,0 +1,16 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "main": "index.js",
+  "author": "Luis Takahashi",
+  "license": "MIT",
+  "dependencies": {
+    "bla": "^0.0.1"
+  },
+  "peerDependencies": {
+    "@scoped/package": "^4.3.5"
+  },
+  "devDependencies": {
+    "@scoped/package1": "^1.0.0"
+  }
+}

example/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "npm-pkg-usage",
+  "name": "pkg-usage",
   "version": "0.1.0",
   "description": "Npm package usage metrics",
   "main": "dist/index.js",
@@ -8,16 +8,20 @@
     "dist",
     "example"
   ],
-  "repository": "https://github.com/luistak/npm-package-usage.git",
+  "bin": {
+    "pkg-usage": "./scripts/pkg-usage.js"
+  },
+  "repository": "https://github.com/luistak/pkg-usage.git",
   "bugs": {
-    "url": "https://github.com/luistak/npm-package-usage/issues"
+    "url": "https://github.com/luistak/pkg-usage/issues"
   },
-  "homepage": "https://github.com/luistak/npm-package-usage",
+  "homepage": "https://github.com/luistak/pkg-usage",
   "author": "Luis Takahashi <takahashihideki408@gmail.com>",
   "license": "MIT",
   "private": false,
   "devDependencies": {
     "@tsconfig/node14": "^1.0.1",
+    "@types/faker": "^5.5.8",
     "@types/jest": "^26.0.24",
     "@types/js-yaml": "^4.0.2",
     "@types/node": "^16.4.2",
@@ -26,8 +30,8 @@
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "3.3.0",
     "eslint": "^7.31.0",
+    "faker": "^5.5.3",
     "jest": "^27.0.6",
-    "js-yaml": "^4.1.0",
     "prettier": ">=2",
     "ts-jest": "^27.0.4",
     "ts-node": "^10.1.0",
@@ -36,10 +40,10 @@
   "scripts": {
     "commit": "cz",
     "preexample": "yarn build",
-    "example": "cd ./example && node run-in-ci.js",
+    "example": "cd ./example && node ../scripts/pkg-usage.js",
     "lint": "eslint . --cache --fix --ext .ts,.tsx",
     "format": "prettier --loglevel warn --write \"**/*.{ts,tsx,css,md}\"",
-    "test:ci": "yarn test --passWithNoTests",
+    "test:ci": "CI=true yarn test:coverage",
     "test:jest": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
@@ -50,21 +54,20 @@
   "jest": {
     "testPathIgnorePatterns": [
       "/node_modules/",
-      "<rootDir>/lib/"
+      "/__tests__/utils.ts"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/__tests__/utils.ts"
     ],
     "transform": {
-      "^.+\\.tsx?$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
+      "^.+\\.tsx?$": "ts-jest"
     },
-    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(ts?|tsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json"
+    "modulePathIgnorePatterns": [
+      "__mocks__"
     ]
   },
   "dependencies": {
+    "pkg-up": "^3.1.0",
     "ts-morph": "^11.0.3"
   },
   "release": {
@@ -78,4 +81,4 @@
       "path": "cz-conventional-changelog"
     }
   }
-}
+}