license_patrol 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4654e0d8c8444ded245bd4960a0897b7ec961ac6329751ae545cefbf907adbd2
4
- data.tar.gz: c7b5677df462576bd56bc82f3114052cbd136afba270effcf19427d8621b5e9f
3
+ metadata.gz: bfadea16931d270ad27f48e5db7d22d95751c39335299a0375b037b192d88925
4
+ data.tar.gz: acba13bf06366eb312bde648d1aefc653576ff2fa67cae75a2cbddf9d697a84b
5
5
  SHA512:
6
- metadata.gz: 01cd7fd00cacc1e8e150294fcdd43abc35261fe2da6e82138e5cc6a335d3503120df25ce0728888bd30cbabae39cd0c81df1c427a7c0b681ef2b4c97f2b8f5e3
7
- data.tar.gz: aed4baf70fad953b9c6fdf6a851e5c1cb0dc6f501f115b9676771b7c82967fd1c40776b36635805961e24ce37896c128436939f80be9ac6acbcb930afa1d6652
6
+ metadata.gz: bd3c0356c36aa7aae5ed0891ce8e4b4baff329fdbbd21f26316f87f13d6de4daf9f4d3b6ed1831f4b1cbac9a7763f0224ef371d9cc2a87abf8ea67e760ad8a10
7
+ data.tar.gz: ba987bba63a5b6161407ad3fb73c904d15e6d4d2438cf6ce8cfea6e867dfb7435e8cfab1be6c7f2b3c2bb34bd19ff955de05155356d0cff3519c58863f7ac89d
@@ -0,0 +1,2 @@
1
+ # Managed by https://github.com/powerhome/software. Do not make changes here, they will be reverted.
2
+ * @powerhome/heroes-for-hire
@@ -0,0 +1,35 @@
1
+ # Managed by https://github.com/powerhome/software. Do not make changes here, they will be reverted.
2
+
3
+ name: 'Close stale issues and PRs'
4
+ on:
5
+ workflow_dispatch:
6
+ schedule:
7
+ - cron: '37 21 * * *'
8
+
9
+ jobs:
10
+ stale:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0
14
+ with:
15
+ operations-per-run: 200
16
+ delete-branch: true
17
+ stale-pr-message: >
18
+ This issue has been automatically marked as stale because it has not had
19
+ recent activity. It will be closed in 24 hours if no further activity occurs.
20
+
21
+ If this change is desirable, please accelerate completing it. If it is not,
22
+ please close the PR. If you're blocked on something, please ensure there's
23
+ a reference to this PR in a story on your team's board so the team will
24
+ follow up, and consider closing the PR for now.
25
+
26
+ Please do not artificially extend the deadline with a dummy comment. If
27
+ necessary, provide a status update, such as "this change is being actively
28
+ tested".
29
+
30
+ Thank you for your contributions and your collaboration in reducing WIP
31
+ and cycle time.
32
+ days-before-stale: 14
33
+ days-before-close: 3
34
+ days-before-issue-stale: -1
35
+ exempt-pr-labels: dependencies
data/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ # [1.2.0] / 2026-10-28
2
+
3
+ ### Fixed
4
+ * Yarn 2, 3 and 4 projects scan without the third-party licenses plugin, reading packages from the built-in `yarn info` - [6a46a083](https://github.com/powerhome/license_patrol/commit/6a46a083) - Carlos Palhares
5
+
6
+ ### Changed
7
+ * Yarn 2+ no longer reports workspaces as packages, and `--prepare` only runs `yarn install` - [6a46a083](https://github.com/powerhome/license_patrol/commit/6a46a083) - Carlos Palhares
8
+
1
9
  # [1.1.0] / 2026-10-21
2
10
 
3
11
  ### Added
data/README.md CHANGED
@@ -48,7 +48,7 @@ and give you an actionable exception report.
48
48
  * Objective-C, Swift (via Carthage, CocoaPods \[0.39 and below. See [CocoaPods Specs Repo Sharding](http://blog.cocoapods.org/Sharding/)\]) and Swift Package Manager(SPM)
49
49
  * Elixir (via `mix`)
50
50
  * Golang (via `gvt`, `glide`,`dep`, `trash` and `govendor`)
51
- * JavaScript (via `yarn`)
51
+ * JavaScript (via `yarn` 1.x through 4.x)
52
52
  * C++/C (via `conan`)
53
53
  * Scala (via `sbt`)
54
54
  * Rust (via `cargo`)
@@ -328,7 +328,7 @@ be approved. The project name at the top of the report can be set with
328
328
  `license_patrol project_name add`.
329
329
 
330
330
  ### Note:
331
- When using the yarn package manager, when a node_module's package.json doesn't
331
+ When using Yarn 1, when a node_module's package.json doesn't
332
332
  explicitly declare a license, yarn indicates that it has inferred the license based
333
333
  on some keywords in other files by appending an asterisk to the license name. If you
334
334
  see a * at the end of the license name, this is intended.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.0
1
+ 1.2.0
@@ -8,30 +8,17 @@ module LicensePatrol
8
8
  end
9
9
 
10
10
  SHELL_COMMAND = 'yarn licenses list --recursive --json'
11
+ BERRY_SHELL_COMMAND = 'yarn info --all --recursive --json --extra manifest'
11
12
 
12
13
  def possible_package_paths
13
14
  [project_path.join('yarn.lock')]
14
15
  end
15
16
 
16
17
  def current_packages
17
- # the licenses plugin supports the classic production flag
18
- cmd = "#{Yarn::SHELL_COMMAND}#{classic_yarn_production_flag}"
19
18
  if yarn_version == 1
20
- cmd += ' --no-progress'
21
- cmd += " --cwd #{project_path}" unless project_path.nil?
22
- cmd += " #{@yarn_options}" unless @yarn_options.nil?
23
- end
24
-
25
- stdout, stderr, status = Dir.chdir(project_path) { Cmd.run(cmd) }
26
- raise "Command '#{cmd}' failed to execute: #{stderr}" unless status.success?
27
-
28
- json_strings = stdout.encode('ASCII', invalid: :replace, undef: :replace, replace: '?').split("\n")
29
- json_objects = json_strings.map { |json_object| JSON.parse(json_object) }
30
-
31
- if yarn_version == 1
32
- get_yarn1_packages(json_objects)
19
+ get_yarn1_packages(run_json_command(classic_shell_command))
33
20
  else
34
- get_yarn_packages(json_objects)
21
+ get_yarn_packages(run_json_command(BERRY_SHELL_COMMAND))
35
22
  end
36
23
  end
37
24
 
@@ -62,20 +49,28 @@ module LicensePatrol
62
49
 
63
50
  private
64
51
 
52
+ # devDependencies are left out when reading the packages, so all of them are installed
65
53
  def yarn_prepare_command
66
- "#{yarn_plugin_production_command}yarn install && yarn plugin import https://raw.githubusercontent.com/mhassan1/yarn-plugin-licenses/#{yarn_licenses_plugin_version}/bundles/@yarnpkg/plugin-licenses.js"
54
+ 'yarn install'
67
55
  end
68
56
 
69
57
  def classic_yarn_prepare_command
70
58
  "yarn install --ignore-engines --ignore-scripts#{classic_yarn_production_flag}"
71
59
  end
72
60
 
73
- def yarn_licenses_plugin_version
74
- if yarn_version == 2
75
- 'v0.6.0'
76
- else
77
- 'v0.7.2'
78
- end
61
+ def classic_shell_command
62
+ cmd = "#{Yarn::SHELL_COMMAND}#{classic_yarn_production_flag} --no-progress"
63
+ cmd += " --cwd #{project_path}" unless project_path.nil?
64
+ cmd += " #{@yarn_options}" unless @yarn_options.nil?
65
+ cmd
66
+ end
67
+
68
+ def run_json_command(cmd)
69
+ stdout, stderr, status = Dir.chdir(project_path) { Cmd.run(cmd) }
70
+ raise "Command '#{cmd}' failed to execute: #{stderr}" unless status.success?
71
+
72
+ json_strings = stdout.encode('ASCII', invalid: :replace, undef: :replace, replace: '?').split("\n")
73
+ json_strings.map { |json_object| JSON.parse(json_object) }
79
74
  end
80
75
 
81
76
  def yarn_version
@@ -88,40 +83,64 @@ module LicensePatrol
88
83
  end
89
84
  end
90
85
 
86
+ # Yarn 2+ prints one line per package in the lockfile, keyed by its locator
87
+ # (e.g. "@babel/core@npm:7.18.6"). Workspaces are the project's own code,
88
+ # so only the packages they depend on are reported.
91
89
  def get_yarn_packages(json_objects)
92
- packages = []
93
- incompatible_packages = []
94
- json_objects.each do |json_object|
95
- license = json_object['value']
96
- body = json_object['children']
97
-
98
- body.each do |package_name, vendor_info|
99
- valid_match = %r{(?<name>@?[\w/.-]+)@(?<manager>\D*):\D*(?<version>(\d+\.?)+)} =~ package_name.to_s
100
- valid_match = %r{(?<name>@?[\w/.-]+)@virtual:.+#(\D*):\D*(?<version>(\d+\.?)+)} =~ package_name.to_s if manager.eql?('virtual')
101
-
102
- if valid_match
103
- homepage = vendor_info['children']['vendorUrl']
104
- author = vendor_info['children']['vendorName']
105
- package = YarnPackage.new(
106
- name,
107
- version,
108
- spec_licenses: [license],
109
- homepage: homepage,
110
- authors: author,
111
- install_path: project_path.join(modules_folder, name)
112
- )
113
- packages << package
114
- end
115
-
116
- incompatible_match = %r{(?<name>@?[\w/.-]+)@[a-z]*:(?<version>(\.))} =~ package_name.to_s
117
- if incompatible_match
118
- package = YarnPackage.new(name, version, spec_licenses: [license])
119
- incompatible_packages.push(package)
120
- end
90
+ infos = json_objects.map { |json_object| [json_object['value'], json_object['children']] }.to_h
91
+ locators = ignore_dev_dependencies? ? production_locators(infos) : infos.keys
92
+
93
+ packages = locators.reject { |locator| workspace_locator?(locator) }.map do |locator|
94
+ name = locator_name(locator)
95
+ info = infos[locator]
96
+ manifest = info['Manifest'] || {}
97
+ YarnPackage.new(
98
+ name,
99
+ info['Version'],
100
+ spec_licenses: [manifest['License']].compact,
101
+ homepage: manifest['Homepage'],
102
+ install_path: project_path.join(modules_folder, name)
103
+ )
104
+ end
105
+
106
+ # a patched package (e.g. typescript) is listed next to the package it patches
107
+ packages.uniq { |package| [package.name, package.version] }
108
+ end
109
+
110
+ # Walks the dependencies of every workspace, skipping the ones they declare
111
+ # in devDependencies, like "yarn workspaces focus --all --production".
112
+ def production_locators(infos)
113
+ seen = Set.new
114
+ pending = infos.keys.select { |locator| workspace_locator?(locator) }
115
+ until pending.empty?
116
+ locator = devirtualize(pending.shift)
117
+ next unless infos.key?(locator) && seen.add?(locator)
118
+
119
+ dev_dependencies = workspace_locator?(locator) ? workspace_dev_dependencies(locator) : []
120
+ (infos[locator]['Dependencies'] || []).each do |dependency|
121
+ pending << dependency['locator'] unless dev_dependencies.include?(locator_name(dependency['descriptor']))
121
122
  end
122
123
  end
124
+ seen.to_a
125
+ end
123
126
 
124
- packages + incompatible_packages.uniq
127
+ def workspace_dev_dependencies(locator)
128
+ workspace_path = locator.delete_prefix("#{locator_name(locator)}@workspace:")
129
+ manifest = JSON.parse(File.read(project_path.join(workspace_path, 'package.json')))
130
+ (manifest['devDependencies'] || {}).keys - (manifest['dependencies'] || {}).keys
131
+ end
132
+
133
+ def locator_name(locator)
134
+ locator[%r{\A(@[^/@]+/)?[^@]+}]
135
+ end
136
+
137
+ def workspace_locator?(locator)
138
+ locator.start_with?("#{locator_name(locator)}@workspace:")
139
+ end
140
+
141
+ # "react-dom@virtual:c6e8...#npm:18.2.0" is "react-dom@npm:18.2.0" with its peer dependencies resolved
142
+ def devirtualize(locator)
143
+ locator.sub(/@virtual:[^#]*#/, '@')
125
144
  end
126
145
 
127
146
  def get_yarn1_packages(json_objects)
@@ -181,15 +200,11 @@ module LicensePatrol
181
200
  end
182
201
 
183
202
  def classic_yarn_production_flag
184
- return '' if @ignored_groups.nil?
185
-
186
- @ignored_groups.include?('devDependencies') ? ' --production' : ''
203
+ ignore_dev_dependencies? ? ' --production' : ''
187
204
  end
188
205
 
189
- def yarn_plugin_production_command
190
- return '' if @ignored_groups.nil?
191
-
192
- @ignored_groups.include?('devDependencies') ? 'yarn plugin import workspace-tools && yarn workspaces focus --all --production && ' : ''
206
+ def ignore_dev_dependencies?
207
+ !@ignored_groups.nil? && @ignored_groups.include?('devDependencies')
193
208
  end
194
209
  end
195
210
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: license_patrol
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ryan Collins
@@ -396,9 +396,11 @@ extensions: []
396
396
  extra_rdoc_files: []
397
397
  files:
398
398
  - ".force-build"
399
+ - ".github/CODEOWNERS"
399
400
  - ".github/dependabot.yml"
400
401
  - ".github/workflows/install-test-tools.sh"
401
402
  - ".github/workflows/license_patrol.yml"
403
+ - ".github/workflows/stale.yml"
402
404
  - ".gitignore"
403
405
  - ".pre-commit-hooks.yaml"
404
406
  - ".rspec"