Skip to content

Commit

Permalink
initial npmignore
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck committed Apr 25, 2022
1 parent fe6309f commit 275616f
Show file tree
Hide file tree
Showing 5 changed files with 329 additions and 2,143 deletions.
149 changes: 141 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,149 @@
node_modules/

## target or reportings, tests, etc
/reports/
/CI_reports/

## target of JSDoc
/out/
/docs/jsdoc/

## target or reportings, tests, etc
/reports/
/CI_reports/
/bom.xml
/bom.json

## caches
/.*.cache

## IDE related files
.vscode/
.idea/
/dist/
/dist.*/

### https://github.com/github/gitignore/blob/main/Node.gitignore

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
181 changes: 181 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
# nodeignore - test with `npm pack`
# content:
# 1. general excludes
# 2. some custom overrides


### https://github.com/github/gitignore/blob/main/Node.gitignore

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*



#### customs and additions below

# ignore dot-files/-folders
.*

# project internals can be ignored
/CODEOWNERS
/CONTRIBUTING.*

# these files are part of the license
!/LICENSE
!/NOTICE

# never ignore the build results - these are intended to be shipped
!/dist/
!/dist.*/

# docker-related stuff
/Dockerfile
/Dockerfile*
/.dockerignore
/.dockerignore*

/test.sh
/test/
/tests/
/examples/

## target of JSDoc
/out/
/docs/jsdoc/

## target or reportings, tests, etc
/reports/
/CI_reports/
/bom.xml
/bom.json

## caches
/.*.cache
9 changes: 7 additions & 2 deletions HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@ All notable changes to this project will be documented in this file.

## unreleased

* Misc:
* Worked packaging from whitelist to blacklist to add files, like `NOTICE`. (via [#289])

[#289]: https://github.com/CycloneDX/cyclonedx-node-module/pull/289

## 3.8.0 - 2022-04-24

* Added
* Added
* Environment variable `BOM_REPRODUCIBLE` causes bom result to be more consistent
over multiple runs by omitting time/rand-based values, and sorting lists. (via [#288])
* Method `Component.compare()` compares self by `purl` or `group`/`name`/`version`. (via [#288])
Expand Down Expand Up @@ -57,7 +62,7 @@ All notable changes to this project will be documented in this file.
* Examples use the preferred call via `cyclonedx-node`, instead of the fallback `cyclonedx-bom`. (via [#258])
This is a follow-up of [#193].
* Tests
* Moved integration tests to a dedicated space and updated documentation for it. (via [#260])
* Moved integration tests to a dedicated space and updated documentation for it. (via [#260])

[#263]: https://github.com/CycloneDX/cyclonedx-node-module/issues/263
[#264]: https://github.com/CycloneDX/cyclonedx-node-module/pull/264
Expand Down
Loading

0 comments on commit 275616f

Please sign in to comment.