Fix build/publish to enable install in other projects

[jaeddy]

I was able to publish the back in npm, but I think I might be doing something wrong. It seems like maybe the dist/ folder isn't getting published?

When I try to install (npm i gh-openapi-docs), I get the following error:

npm ERR! path /Users/jaeddy/node_modules/gh-openapi-docs/dist/gh-openapi-docs.js
npm ERR! code ENOENT
npm ERR! errno -2
npm ERR! syscall chmod
npm ERR! enoent ENOENT: no such file or directory, chmod '/Users/jaeddy/node_modules/gh-openapi-docs/dist/gh-openapi-docs.js'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 

[jb-adams]

could this be caused by the repo not tracking the dist folder? I added dist to .gitignore since it's distribution code, but didn't know this would cause errors in npm

Is it failing to build on your local?

[jaeddy]

Not tracking the dist folder seems like standard practice, from what I've been able to find while looking around for answers. Build works just fine locally (at least within the same directory).

[jaeddy]

One problem I found was lines like this in bundle.js and redoc-ui.js:

    shell.exec(
        `npm run swagger bundle --        -b ${specDir} -o ${OPENAPI_JSON_PATH}`
    );
    shell.exec(
        `npm run swagger bundle -- --yaml -b ${specDir} -o ${OPENAPI_YAML_PATH}`
    );

I shouldn't be including the npm run, just using the CLI's bin entrypoint (i.e., swagger-repo) after installing globally. Doesn't fix the core problem (or #10), but useful to know. I also realized that swagger-repo is no longer maintained, and I should switch the dependency to openapi-cli.

[jaeddy]

#14 did not fix the problem with npm. I really thought the suggestions in this post would do the trick, but still no luck. Calling it a night... will revisit tomorrow.

[tschaffter]

Running with --loglevel=info for additional info:

npm install gh-openapi-docs --loglevel=info
...
npm info linkStuff update-notifier@3.0.1
npm info linkStuff yargs-parser@15.0.0
npm info linkStuff gh-openapi-docs@0.1.8
npm timing action:build Completed in 120ms
npm timing stage:rollbackFailedOptional Completed in 803ms
npm timing stage:runTopLevelLifecycles Completed in 12075ms
npm WARN enoent ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm WARN tmp No description
npm WARN tmp No repository field.
npm WARN tmp No README data
npm WARN tmp No license field.

npm ERR! code ENOENT
npm ERR! syscall chmod
npm ERR! path /Users/tschaffter/dev/tmp/node_modules/gh-openapi-docs/dist/bundle.js
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, chmod '/Users/tschaffter/dev/tmp/node_modules/gh-openapi-docs/dist/bundle.js'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 
npm http fetch POST 503 https://registry.npmjs.org/-/npm/v1/security/audits/quick 13200ms
npm timing npm Completed in 21665ms

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/tschaffter/.npm/_logs/2020-03-26T17_58_31_338Z-debug.log

[tschaffter]

It's confirmed that dist/bundle.js is not included in the npm package created by release-it even though dist/bundle.js exists at the time the packaging.

$ npm view gh-openapi-docs-dev

gh-openapi-docs-dev@1.0.0-beta.1 | Proprietary | deps: 18 | versions: 4
## Installation

bin: gh-openapi-docs-dev

dist
.tarball: https://registry.npmjs.org/gh-openapi-docs-dev/-/gh-openapi-docs-dev-1.0.0-beta.1.tgz
.shasum: e5b9c2636cb0180c373026ad909b366a30340a0c
.integrity: sha512-YCty1eRk7MKojveHeUafFHJWN3L+5EUt0pfZNZOpYvcJPgihWQXVjbJwdCZugKTZabjarkAsqjrPMRl0bRwKNA==
.unpackedSize: 33.0 kB

dependencies:
@babel/runtime: ^7.6.3         is-ci: ^2.0.0                  lodash: ^4.17.15               redoc-cli: ^0.9.6              update-notifier: 3.0.1         
@redocly/openapi-cli: 0.8.4    json-refs: ^3.0.15             oas-linter: ^3.0.2             remote-origin-url: ^2.0.0      yargs-parser: 15.0.0           
chalk: 2.4.2                   json-schema-ref-parser: ^7.1.3 oas-resolver: ^2.2.7           shelljs: ^0.7.0                
git-repo-info: ^2.1.1          loader-utils: ^1.4.0           oas-validator: ^3.3.3          swagger-ui-dist: 3.24.0        

maintainers:
- tschaffter <thomas.schaffter@gmail.com>

dist-tags:
beta: 1.0.0-beta.4    latest: 1.0.0-beta.1  

published 33 minutes ago by tschaffter <thomas.schaffter@gmail.com>

[tschaffter]

https://docs.npmjs.com/files/package.json#files

The issue may be because bin is listed in .npmignore

[tschaffter]

The issue seems to originate from release-it. Publishing the npm package using npm publish should solve the problem. See below using a fork of this repo and the associated npm package https://www.npmjs.com/package/gh-openapi-docs-dev (notice the -dev suffix):

$ list-npm-contents gh-openapi-docs-dev | grep dist
dist/bundle.js

$ npm i gh-openapi-docs-dev
npm WARN deprecated mkdirp@0.5.4: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)
npm WARN deprecated superagent@3.8.3: Please note that v5.0.1+ of superagent removes User-Agent header by default, therefore you may need to add it yourself (e.g. GitHub blocks requests without a User-Agent header).  This notice will go away with v5.0.2+ once it is released.

> core-js@3.6.4 postinstall /Users/tschaffter/dev/node_modules/core-js
> node -e "try{require('./postinstall')}catch(e){}"


> styled-components@4.4.1 postinstall /Users/tschaffter/dev/node_modules/styled-components
> node ./scripts/postinstall.js || exit 0

Use styled-components at work? Consider supporting our development efforts at https://opencollective.com/styled-components
npm WARN saveError ENOENT: no such file or directory, open '/Users/tschaffter/dev/package.json'
npm WARN enoent ENOENT: no such file or directory, open '/Users/tschaffter/dev/package.json'
npm WARN dev No description
npm WARN dev No repository field.
npm WARN dev No README data
npm WARN dev No license field.

+ gh-openapi-docs-dev@1.0.0-beta.13
added 445 packages from 279 contributors and audited 1749 packages in 13.427s

8 packages are looking for funding
  run `npm fund` for details

found 2 low severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

[tschaffter]

This solution is to make sure that dist/bundle.js exists locally when creating the npm package. The package installation can be tested locally before publishing it to npm.

• Installing this package from a temp directory when dist/bundle.js is missing (failure):

$ npm i /Users/tschaffter/dev/gh-openapi-docs
npm WARN enoent ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm WARN ajv-keywords@3.4.1 requires a peer of ajv@^6.9.1 but none is installed. You must install peer dependencies yourself.
npm WARN tmp No description
npm WARN tmp No repository field.
npm WARN tmp No README data
npm WARN tmp No license field.

npm ERR! code ENOENT
npm ERR! syscall chmod
npm ERR! path /Users/tschaffter/dev/tmp/node_modules/gh-openapi-docs-dev/dist/bundle.js
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, chmod '/Users/tschaffter/dev/tmp/node_modules/gh-openapi-docs-dev/dist/bundle.js'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/tschaffter/.npm/_logs/2020-03-27T00_09_48_083Z-debug.log

• Installing this package from a temp directory when dist/bundle.js is present (success):

$ npm i /Users/tschaffter/dev/gh-openapi-docs
npm WARN saveError ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm WARN ajv-keywords@3.4.1 requires a peer of ajv@^6.9.1 but none is installed. You must install peer dependencies yourself.
npm WARN tmp No description
npm WARN tmp No repository field.
npm WARN tmp No README data
npm WARN tmp No license field.

+ gh-openapi-docs-dev@1.0.0-beta.22
added 24 packages from 20 contributors and audited 1749 packages in 3.265s

28 packages are looking for funding
  run `npm fund` for details

found 2 low severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

Since then, @jaeddy has published a new release on npm which includes dist/bundle.js:

$ list-npm-contents gh-openapi-docs --module-version 0.1.9 | grep dist
dist/bundle.js

The package installation is now successful:

$ npm i gh-openapi-docs
npm WARN deprecated mkdirp@0.5.4: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)
npm WARN deprecated superagent@3.8.3: Please note that v5.0.1+ of superagent removes User-Agent header by default, therefore you may need to add it yourself (e.g. GitHub blocks requests without a User-Agent header).  This notice will go away with v5.0.2+ once it is released.

> core-js@3.6.4 postinstall /Users/tschaffter/dev/tmp/node_modules/core-js
> node -e "try{require('./postinstall')}catch(e){}"

Thank you for using core-js ( https://github.com/zloirock/core-js ) for polyfilling JavaScript standard library!

The project needs your help! Please consider supporting of core-js on Open Collective or Patreon: 
> https://opencollective.com/core-js 
> https://www.patreon.com/zloirock 

Also, the author of core-js ( https://github.com/zloirock ) is looking for a good job -)


> styled-components@4.4.1 postinstall /Users/tschaffter/dev/tmp/node_modules/styled-components
> node ./scripts/postinstall.js || exit 0

Use styled-components at work? Consider supporting our development efforts at https://opencollective.com/styled-components
npm WARN saveError ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/Users/tschaffter/dev/tmp/package.json'
npm WARN tmp No description
npm WARN tmp No repository field.
npm WARN tmp No README data
npm WARN tmp No license field.

+ gh-openapi-docs@0.1.9
added 445 packages from 279 contributors and audited 1749 packages in 13.817s

8 packages are looking for funding
  run `npm fund` for details

found 2 low severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

[jaeddy]

I think I fixed this issue by building and publishing with npm instead of trying to use release-it — I'll double check the PR and close when confirmed.