chore: prepare for first release

Author: joscha

.github/workflows/npm-publish.yml

@@ -0,0 +1,26 @@
+name: npm-publish
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    # only allow on main or tags
+    if: ${{ github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+      # We're using npm to publish due to: https://github.com/yarnpkg/yarn/issues/5779
+      - run: npm install
+      - id: publish
+        uses: JS-DevTools/[email protected]
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          dry-run: ${{ github.event.action != 'published' }}
+      - if: steps.publish.outputs.type != 'none'
+        run: |
+          echo "Version changed: ${{ steps.publish.outputs.old-version }} => ${{ steps.publish.outputs.version }}"

.gitignore

@@ -2,3 +2,4 @@
 /coverage
 /dist
 yarn-error.log
+/canva-public-dependency-tree-*.tgz

README.md

@@ -1,6 +1,7 @@
-# dependency-tree
+# @canva-public/dependency-tree
 
-![build](https://github.com/canva-public/dependency-tree/actions/workflows/node.js.yml/badge.svg)
+[![build](https://github.com/canva-public/dependency-tree/actions/workflows/node.js.yml/badge.svg)](https://github.com/canva-public/dependency-tree/actions/workflows/node.js.yml)
+[![npm](https://img.shields.io/npm/v/@canva-public/dependency-tree.svg)](https://www.npmjs.com/package/@canva-public/dependency-tree)
 
 This package can create a dependency tree from a given set of files/folders.
 The nodes of the tree are files and the edges are file -> file dependencies.
@@ -42,3 +43,10 @@ const directOrTransitiveDependencies = DependencyTree.getDependencies(
 
 - Visualisation of (epxlicit and implicit) in-code dependencies
 - Identifying build targets that need to be regenerated based on affected code
+
+## Releasing
+
+- Bump the version of `package.json` to a meaningful version for the changes since the last release (we follow semver).
+- To do a dry-run of the release and what would go out in the package you can manually execute the [npm-publish](https://github.com/canva-public/dependency-tree/actions/workflows/npm-publish.yml) workflow on the `main` branch. It will do a dry-run publish (not actually publish the new version).
+- Draft a new release in the github project - please use a tag named `vX.X.X` (where `X.X.X` is the new to-be-releases semver of the package - please add as many detail as possible to the release description.
+- Once you're ready, `Publish` the release. Publishing will trigger the [npm-publish](https://github.com/canva-public/dependency-tree/actions/workflows/npm-publish.yml) workflow on the tag and do the actual publish to npm.

jest.config.js

@@ -2,7 +2,7 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: [
-    '/dist',
+    '/dist/',
     '/node_modules/',
     '/fixtures/',
     '.eslintrc.js',

package.json

@@ -1,10 +1,13 @@
 {
-  "name": "@canva/dependency-tree",
-  "version": "2.4.3",
+  "name": "@canva-public/dependency-tree",
+  "version": "2.4.4",
   "description": "Calculates a dependency tree for set of files",
   "main": "dist/index.js",
   "author": "Canva Pty Ltd",
   "license": "MIT",
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+ssh://[email protected]/canva-public/depdendency-tree.git"
@@ -17,13 +20,13 @@
   ],
   "scripts": {
     "prettier": "prettier --write .",
-    "prepare": "rimraf dist/ && tsc",
+    "prepack": "tsc --declarationDir dist --declaration",
+    "prepare": "rm -rf ./dist",
     "eslint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "pretest": "prettier --check . && yarn eslint",
     "test": "jest --ci --coverage",
     "test:watch": "jest --watch --notify"
   },
-  "private": true,
   "dependencies": {
     "acorn": "^8.0.4",
     "builtin-modules": "^3.2.0",
@@ -38,6 +41,7 @@
     "lodash.escaperegexp": "^4.1.2",
     "lodash.memoize": "^4.1.2",
     "memoize-fs": "^2.2.0",
+    "pkginfo": "^0.4.1",
     "xml2js": "^0.4.23"
   },
   "devDependencies": {

src/logger.ts

@@ -2,4 +2,4 @@
 
 import * as createDebug from 'debug';
 
-export const debug = createDebug('@canva/dependency-tree');
+export const debug = createDebug('@canva-public/dependency-tree');

src/processors/typescript.ts

@@ -10,7 +10,14 @@ import { DependencyTree, FileToDeps, Path } from '../';
 import { FileProcessor } from '../file_processor';
 import { debug as logger } from '../logger';
 import memoize = require('lodash.memoize');
-import { name, version } from '../../package.json';
+
+// we can't use the simple
+// import { name, version } from '../../package.json';
+// here as during the build phase TS then nests outputs in the dist dir
+// in order to include the package.json as a parent
+// @ts-expect-error pkinfo does not come with type defs and output is variable
+import * as pkginfo from 'pkginfo';
+const { name, version } = pkginfo.read(module).package;
 
 // this memoizes function invocations with a cache on disk so caching works across invocations of
 // the script, not just the function.

yarn.lock

@@ -3761,6 +3761,11 @@ pkg-dir@^4.2.0:
   dependencies:
     find-up "^4.0.0"
 
+pkginfo@^0.4.1:
+  version "0.4.1"
+  resolved "https://registry.yarnpkg.com/pkginfo/-/pkginfo-0.4.1.tgz#b5418ef0439de5425fc4995042dced14fb2a84ff"
+  integrity sha1-tUGO8EOd5UJfxJlQQtztFPsqhP8=
+
 posix-character-classes@^0.1.0:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/posix-character-classes/-/posix-character-classes-0.1.1.tgz#01eac0fe3b5af71a2a6c02feabb8c1fef7e00eab"