Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix plugin name #41

Merged
merged 1 commit into from
Mar 21, 2024
Merged

fix plugin name #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Then, import the bundle into your project using `yarn import ...`,
or reference it in environment variable [`YARN_PLUGINS`](https://yarnpkg.com/advanced/plugin-tutorial#dynamically-loading-plugins-using-the-yarn_plugins-environment-variable) — like so:

```shell
YARN_PLUGINS=.../bundles/@yarnpkg/plugin-sbom.js yarn sbom --help
YARN_PLUGINS=.../bundles/@yarnpkg/plugin-cyclonedx.js yarn sbom --help
```

## Usage
Expand All @@ -53,7 +53,7 @@ Generates CycloneDX SBOM for current workspace.

━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ yarn CycloneDX make-sbom
$ yarn cyclonedx

━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Expand Down
50 changes: 48 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,54 @@
{
"private": true,
"name": "yarn-plugin-sbom",
"name": "@cyclonedx/yarn-plugin-cyclonedx",
"version": "1.0-dev",
"description": "Create CycloneDX Software Bill of Materials (SBOM) from yarn projects.",
"license": "Apache-2.0",
"keywords": [
"CycloneDX",
"SBOM",
"BOM",
"inventory",
"bill-of-materials",
"software-bill-of-materials",
"component",
"dependency",
"package-url",
"PURL",
"spdx",
"node",
"yarn"
],
"homepage": "https://github.com/CycloneDX/cyclonedx-node-yarn#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/CycloneDX/cyclonedx-node-yarn.git"
},
"bugs": {
"url": "https://github.com/CycloneDX/cyclonedx-node-yarn/issues"
},
"funding": [
{
"type": "individual",
"url": "https://owasp.org/donate/?reponame=www-project-cyclonedx&title=OWASP+CycloneDX"
}
],
"contributors": [
{
"name": "Jan Kowalleck",
"url": "https://github.com/jkowalleck"
},
{
"name": "Augustus Kling",
"url": "https://github.com/AugustusKling"
}
],
"maintainers": [
{
"name": "Jan Kowalleck",
"url": "https://github.com/jkowalleck"
}
],
"main": "./sources/index.ts",
"engines": {
"yarn": ">=4",
Expand Down Expand Up @@ -50,7 +96,7 @@
"test:lint": "tsc --noEmit",
"test:node": "c8 mocha -p",
"cs-fix": "eslint --fix .",
"dogfooding": "YARN_PLUGINS=$PROJECT_CWD/bundles/@yarnpkg/plugin-sbom.js yarn sbom"
"dogfooding": "YARN_PLUGINS=$PROJECT_CWD/bundles/@yarnpkg/plugin-cyclonedx.js yarn cyclonedx"
},
"packageManager": "yarn@4.1.0"
}
2 changes: 1 addition & 1 deletion sources/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ import { generateSBOM, type OutputOptions, OutputStdOut } from './sbom'

class SBOMCommand extends BaseCommand {
static override readonly paths = [
['cyclonedx'], // <-- this is the preferred entry point
['CycloneDX', 'make-sbom'],
['cyclonedx'],
['sbom']
]

Expand Down
6 changes: 3 additions & 3 deletions tests/integration/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ const latestCdxSpecVersion = '1.5'
suite('integration', () => {
const UPDATE_SNAPSHOTS = !!process.env.CYARN_TEST_UPDATE_SNAPSHOTS

const thisYarnPlugin = path.resolve(__dirname, '..', '..', 'bundles', '@yarnpkg', 'plugin-sbom.js')
const thisYarnPlugin = path.resolve(__dirname, '..', '..', 'bundles', '@yarnpkg', 'plugin-cyclonedx.js')

suite('make SBOM', () => {
testSetups.forEach((testSetup) => {
test(`${testSetup}`, () => {
const expectedOutSnap = path.resolve(__dirname, '_snapshots', `${testSetup}.json.bin`)

const makeSBOM = spawnSync(
'yarn', ['sbom',
'yarn', ['cyclonedx',
'-vvv',
'--reproducible',
// no intention to test all the spec-versions nor all the output-formats - this would be not our scope.
Expand All @@ -69,7 +69,7 @@ suite('integration', () => {
YARN_PLUGINS: thisYarnPlugin
}
})
assert.strictEqual(makeSBOM.status, 0, makeSBOM.stderr.toString())
assert.strictEqual(makeSBOM.status, 0, makeSBOM.stdout)

const actualOutput = makeReproducible('json', makeSBOM.stdout.toString())

Expand Down
64 changes: 32 additions & 32 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,38 @@ __metadata:
languageName: node
linkType: hard

"@cyclonedx/yarn-plugin-cyclonedx@workspace:.":
version: 0.0.0-use.local
resolution: "@cyclonedx/yarn-plugin-cyclonedx@workspace:."
dependencies:
"@cyclonedx/cyclonedx-library": "npm:^6.4.0"
"@types/mocha": "npm:^10.0.6"
"@types/node": "npm:ts5.4"
"@typescript-eslint/eslint-plugin": "npm:6.21.0"
"@typescript-eslint/parser": "npm:6.21.0"
"@yarnpkg/builder": "npm:4.0.0"
"@yarnpkg/cli": "npm:^4.1.0"
"@yarnpkg/core": "npm:^4.0.3"
c8: "npm:^9.1.0"
clipanion: "npm:^4.0.0-rc.3"
eslint: "npm:8.57.0"
eslint-config-standard: "npm:^17.1.0"
eslint-config-standard-with-typescript: "npm:43.0.1"
eslint-plugin-header: "npm:3.1.1"
eslint-plugin-import: "npm:2.29.1"
eslint-plugin-jsdoc: "npm:48.2.1"
eslint-plugin-n: "npm:16.6.2"
eslint-plugin-promise: "npm:6.1.1"
eslint-plugin-simple-import-sort: "npm:12.0.0"
mocha: "npm:10.3.0"
npm-run-all2: "npm:^6.1.2"
packageurl-js: "npm:^1.2.1"
rimraf: "npm:^5.0.5"
typescript: "npm:5.4.3"
xmlbuilder2: "npm:^3.1.1"
languageName: unknown
linkType: soft

"@es-joy/jsdoccomment@npm:~0.42.0":
version: 0.42.0
resolution: "@es-joy/jsdoccomment@npm:0.42.0"
Expand Down Expand Up @@ -5885,38 +5917,6 @@ __metadata:
languageName: node
linkType: hard

"yarn-plugin-sbom@workspace:.":
version: 0.0.0-use.local
resolution: "yarn-plugin-sbom@workspace:."
dependencies:
"@cyclonedx/cyclonedx-library": "npm:^6.4.0"
"@types/mocha": "npm:^10.0.6"
"@types/node": "npm:ts5.4"
"@typescript-eslint/eslint-plugin": "npm:6.21.0"
"@typescript-eslint/parser": "npm:6.21.0"
"@yarnpkg/builder": "npm:4.0.0"
"@yarnpkg/cli": "npm:^4.1.0"
"@yarnpkg/core": "npm:^4.0.3"
c8: "npm:^9.1.0"
clipanion: "npm:^4.0.0-rc.3"
eslint: "npm:8.57.0"
eslint-config-standard: "npm:^17.1.0"
eslint-config-standard-with-typescript: "npm:43.0.1"
eslint-plugin-header: "npm:3.1.1"
eslint-plugin-import: "npm:2.29.1"
eslint-plugin-jsdoc: "npm:48.2.1"
eslint-plugin-n: "npm:16.6.2"
eslint-plugin-promise: "npm:6.1.1"
eslint-plugin-simple-import-sort: "npm:12.0.0"
mocha: "npm:10.3.0"
npm-run-all2: "npm:^6.1.2"
packageurl-js: "npm:^1.2.1"
rimraf: "npm:^5.0.5"
typescript: "npm:5.4.3"
xmlbuilder2: "npm:^3.1.1"
languageName: unknown
linkType: soft

"yocto-queue@npm:^0.1.0":
version: 0.1.0
resolution: "yocto-queue@npm:0.1.0"
Expand Down