Feat/depend #659

nikhedonia · 2018-02-16T04:12:17Z

this package is a cli tool for dependency analysis for packages.
It implements linting and automatic fixing of version numbers.
Furthermore it can print graphviz compatible description to console.

Once merged we can add a linting and fix commands to our package.json files.
eg.:
depend -e "packages/*/package.json" -s conservative --bail which would result in an exit code of one if we have divergent package versions or a outdated times-component-package in use.

for quick fixing I'd suggest to use:
depend -e "packages/*/package.json" -s majorityProgressive --fix
which would automatically resolve all version number issues by the following rules:

if a dependency is a times-component package, take the latest version

if there are multiple versions used in the codebase use what the majority uses.
if it's a tie: use the latest version (progressive)

More Examples

depend -g "@times-components/*=>dextrose@" | fdp -Tsvg -o dextrose.svg

depend -g "*/ad@ => *" | circo -Tgif -o ad.gif

depend --hint --strategy majority

packages/gestures/package.json
     dextrose: 1.3.2 -> 1.4.5
packages/slice/package.json
     @times-components/article: 0.32.7 -> 0.37.0
     dextrose: 1.4.0 -> 1.4.5
packages/tealium/package.json
     react-native-web: 0.1.14 -> 0.3.2
packages/utils/package.json
     @times-components/jest-configurator: 0.0.23 -> 0.2.0

depend --list -e "packages/*/package.json"

@times-components/watermark 0.3.4
2 prop-types 15.6.0
3 react-broadcast 0.5.2
4 @storybook/addon-actions 3.3.11
5 @storybook/react-native 3.3.11
6 @times-components/eslint-config-thetimes 0.1.3
7 dextrose 1.4.5 1.4.0 1.3.2
[...]

QuickInstall

git ch feat/checkdep
npm pack packages/depend/
npm i -g times-components-depend-0.0.1.tgz
git ch - # back to work
depend -e "packages/*/package.json"--hint -s majorityProgressive # show all packages that need fixing
depend -e "packages/*/package.json" --fix -s majorityProgressive # fix what needs fixing

Limitations

currently ambitious version ranges are not supported.

times-tools · 2018-02-16T04:16:58Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/50bd60f48fb3b35046eaa33ad21b77ad1770c464/dextrose-test/index.html

times-tools · 2018-02-16T04:38:35Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/f97510138fce2819a495d9dc3985aaa27666ac1c/dextrose-test/index.html

times-tools · 2018-02-16T04:55:48Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/c7d308fda7ac9e8e53ae86d208d27f3f22404781/dextrose-test/index.html

times-tools · 2018-02-16T05:11:40Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/2f2c2c30a3ad6ba618c36cc771449a3013fd2777/dextrose-test/index.html

times-tools · 2018-02-16T09:36:12Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/8a64ff9e9ec70ae356b3e9da190970873b3e4554/dextrose-test/index.html

times-tools · 2018-02-16T19:25:30Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/2ce2cfa24e9a22ee6253534884ee0968bd30c890/dextrose-test/index.html

times-tools · 2018-02-16T19:45:54Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/0e75714a39f786265b7ef242d5965d23fac30b3d/dextrose-test/index.html

times-tools · 2018-02-16T22:07:39Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/fe1ad8e709c14c56f31e3d32e03eaad2cfef2049/dextrose-test/index.html

times-tools · 2018-02-17T15:07:26Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/0b1d5bf9083598a408c9acf0cf4ff95d3208f940/dextrose-test/index.html

times-tools · 2018-02-17T15:18:51Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/4ffccab58b59b1534a07d4f89abb0ac8f1575d0f/dextrose-test/index.html

times-tools · 2018-02-17T15:28:34Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/93dd2d6b028e856b79c4a24b5421b16a61cccd7d/dextrose-test/index.html

times-tools · 2018-02-17T15:54:40Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/37904cc36a5c6d75eef7cc7b400d47d879fed23b/dextrose-test/index.html

times-tools · 2018-02-17T16:01:23Z

Please find visual snapshots of your changed components here: https://s3-eu-west-1.amazonaws.com/times-components-snaps/a2ecfa3d3db1eccfee00aeb3629a2eac0a03ff64/dextrose-test/index.html

jimhunty · 2018-02-20T15:47:33Z

packages/depend/README.md

+# Usage
+
+```
+depend -e "packages/*/package.json" [...options]


As it intends to always be a package dependency tool, cant we remove the need for packages/*/package.json ? Just seems like extra typing

It actually defaults to packages/*/package.json; maybe it would be better to read this from the lerna.json file?.

However if you run it within packages/ad the expression will change.

I've also been using it a lot to analyse the node_modules folder to find out which dependency installs what.

+1 for using the lerna.json

lerna support added

jimhunty · 2018-02-20T15:48:29Z

packages/depend/README.md

+
+fixes the packages that are not in-sync
+
+## --graph, -g ["{filter}"]


Worth actually deploying these images somewhere and linking them into the PRs?

It actually only creates a graphviz compatible output that can then be rendered to an image (see PR). Where would you guys suggest to upload those files ?

jimhunty · 2018-02-20T15:59:33Z

packages/depend/strategies.js

+  return (a, b) => s1(a, b) || s2(a, b);
+}
+
+// TODO: support semver ranges


Worth adding as an issue or a Jira ticket

jimhunty · 2018-02-20T16:01:31Z

packages/depend/cli-options.js

@@ -0,0 +1,40 @@
+import optimist from "optimist";


This packages is deprecated?

true, couldn't get it working with yargs though...

can we try?

craigbilner

will merge as now mature and useful but if you could pick up on the comments you can

would be good to fill the test coverage holes too which don't seem too problematic

biggest issue atm is the requirement to provide -l . for every call which isn't obvious from the README

craigbilner · 2018-02-27T21:48:25Z

packages/depend/README.md

+
+Based on the parsed packages, linting rules are computed. Based on those rules,
+hints are computed and can be displayed using `--hint` and applied with `--fix`.
+Strategies add additional rules for ensuring packages install the same external


You can provide your own strategy and additional rules...?

craigbilner · 2018-02-27T21:53:29Z

packages/depend/README.md

+# Linting
+
+Based on the parsed packages, linting rules are computed. Based on those rules,
+hints are computed and can be displayed using `--hint` and applied with `--fix`.


could we have a message if you pass no flags to advise and a message if there's nothing to change?

craigbilner · 2018-02-27T21:55:27Z

packages/depend/README.md

+# Usage
+
+```
+depend --lerna "{path/to/lerna/project}" [...options]


if you run at root guess you don't need to do this? Looks like it needs some error handling too

craigbilner · 2018-02-27T22:18:43Z

packages/depend/README.md

+}
+```
+
+`depend -g` outputs all dependencies in `.dot` format:


graph has to take a pattern?

craigbilner · 2018-02-27T22:23:07Z

packages/depend/README.md

+Depend itself does not have any rendering capabilities but `--graph` output can
+be directly piped into a [graphviz](https://www.graphviz.org/) renderer.
+
+`depend -g "@times-components/*=>dextrose@" | fdp -Tsvg -o dextrose.svg`


might want to mention you need to have graphviz installed at this point?

craigbilner · 2018-02-27T22:25:53Z

packages/depend/README.md

+
+`=>jest`
+
+everything that installs jest


this seems to output any package that contains jest in it?

craigbilner · 2018-02-27T22:27:29Z

packages/depend/__tests__/apply-fix.test.js

@@ -0,0 +1,54 @@
+import { applyPatch } from "../depend";
+
+describe("depend apply-patch tests", () => {


ideally these should read as sentences

craigbilner · 2018-02-27T22:29:51Z

packages/depend/package.json

+    "fmt": "prettier --write '**/*.*'",
+    "prettier:diff": "prettier --list-different '**/*.*'",
+    "lint": "eslint . && npm run prettier:diff",
+    "test": "jest --bail --ci --coverage"


we don't use these flags at the package level anymore

craigbilner · 2018-02-27T22:30:27Z

packages/depend/depend.js

+          packageJson.dependencies[name],
+          version
+        ])
+        .filter(x => x[1]),


still some cryptic refs like this that should be refactored

nikhedonia force-pushed the feat/checkdep branch from 28d1fdb to 2f2c2c3 Compare February 16, 2018 05:06

nikhedonia force-pushed the feat/checkdep branch 2 times, most recently from 266cac4 to 8a64ff9 Compare February 16, 2018 09:29

craigbilner mentioned this pull request Feb 16, 2018

chore: fix article version #661

Merged

nikhedonia force-pushed the feat/checkdep branch 2 times, most recently from 7ff3952 to 0e75714 Compare February 16, 2018 19:35

nikhedonia force-pushed the feat/checkdep branch from 0e75714 to fe1ad8e Compare February 16, 2018 21:54

nikhedonia force-pushed the feat/checkdep branch 2 times, most recently from 4ffccab to 93dd2d6 Compare February 17, 2018 15:18

nikhedonia force-pushed the feat/checkdep branch from 93dd2d6 to 37904cc Compare February 17, 2018 15:49

nikhedonia force-pushed the feat/checkdep branch from 37904cc to a2ecfa3 Compare February 17, 2018 15:56

jimhunty reviewed Feb 20, 2018

View reviewed changes

nikhedonia added 5 commits February 21, 2018 21:20

feat: initial implementation for checkdep

90dcde9

wip: rewrite in es6+

45649c2

wip: split into multiple functions

ea63ccd

feat: adds colours and options to depcheck

4e24048

chore: make linter happy

f6b1daa

nikhedonia added 7 commits February 27, 2018 16:39

chore: adds tests for depend/graph

e96efb2

chore: move requirements to fixtures in depend

f7f6d6c

fix: fixes depend build

4e6cbae

docs: improves readme

75cc547

feat: support for lerna.json for depend.json

5d64f24

chore: moves argument validation from main to cli-parser in depend

867d91d

chore: make linter happy

b629f4b

nikhedonia force-pushed the feat/checkdep branch 11 times, most recently from fdf122d to c71cd57 Compare February 27, 2018 20:15

chore: improve wording

3048363

nikhedonia force-pushed the feat/checkdep branch from c71cd57 to 3048363 Compare February 27, 2018 20:16

nikhedonia and others added 2 commits February 27, 2018 21:03

chore: update snapshots

174da1d

chore: bump yarn

b6759d4

craigbilner reviewed Feb 27, 2018

View reviewed changes

craigbilner approved these changes Feb 27, 2018

View reviewed changes

craigbilner merged commit c967e4b into master Feb 27, 2018

craigbilner deleted the feat/checkdep branch February 27, 2018 22:35

colincclark pushed a commit that referenced this pull request Feb 28, 2018

feat: add depend (#659)

b855744

nikhedonia added a commit that referenced this pull request Mar 6, 2018

feat: add depend (#659)

01847bd

snyk-bot mentioned this pull request Sep 12, 2020

[Snyk] Security upgrade node-fetch from 2.2.0 to 2.6.1 joshje/times-components#229

Open

snyk-bot mentioned this pull request Jan 18, 2022

[Snyk] Security upgrade node-fetch from 2.2.0 to 2.6.7 joshje/times-components#364

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/depend #659

Feat/depend #659

nikhedonia commented Feb 16, 2018 •

edited

Loading

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

jimhunty Feb 20, 2018

nikhedonia Feb 20, 2018

craigbilner Feb 23, 2018

nikhedonia Feb 27, 2018

jimhunty Feb 20, 2018

nikhedonia Feb 20, 2018

jimhunty Feb 20, 2018

jimhunty Feb 20, 2018

nikhedonia Feb 20, 2018

craigbilner Feb 24, 2018

craigbilner left a comment

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018

craigbilner Feb 27, 2018


		fixes the packages that are not in-sync

		## --graph, -g ["{filter}"]

		@@ -0,0 +1,54 @@
		import { applyPatch } from "../depend";

		describe("depend apply-patch tests", () => {

Feat/depend #659

Feat/depend #659

Conversation

nikhedonia commented Feb 16, 2018 • edited Loading

More Examples

QuickInstall

Limitations

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 16, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

times-tools commented Feb 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

craigbilner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nikhedonia commented Feb 16, 2018 •

edited

Loading