@redocly/reference-docs

v2.45.5
Redocly Reference Docs

Readme Versions Dependencies Scripts

prepublishOnly-local

npm run clean && npm run bundle && npm run compile-lib && npm run bundle-cli && npm run prepublish-test

clean

rm -rf bin dist lib lib-esm cli-zip redocly-static lib-browser

bundle

webpack --mode=production

compile-lib

npm run compile-es5 && npm run compile-esm && npm run compile-browser && npm run bundle-worker && npm run bundle-browser

compile-es5

rm -rf lib && tsc -p tsconfig.lib.json && node scripts/minify.js lib

compile-browser

rm -rf lib-browser && tsc -p tsconfig.browser.json && node scripts/minify.js lib-browser

compile-esm

rm -rf lib-esm && tsc -p tsconfig.lib-esm.json && node scripts/minify.js lib-esm

bundle-worker

webpack --config webpack.config.worker.js --mode=production

bundle-browser

webpack --config webpack.config.browser.js --mode=production && webpack --config webpack.config.worker.js --mode=production --env browser

bundle-cli

webpack --config webpack.config.server.js --mode=production && cp -Rf src/cli/assets bin/cli/assets

publish-cli-s3

scripts/publish-cli-s3.sh

deploy-local

ENV=local npm run bundle-cli && ENV=local npm run publish-cli-s3

publish-cdn

scripts/publish-cdn.sh

clear-cache

scripts/clear-cache.sh

pack-sourcemaps

rm -rf reference-docs.sourcemaps.tag.gz && find lib lib-esm -name "*.js.map" | xargs tar -czvf reference-docs.sourcemaps.tar.gz

start

webpack serve --mode=development --hot

stats

webpack --json --profile --mode=production -p > stats.json && npx webpack-bundle-analyzer stats.json

prettier

prettier --write "src/cli/cli.ts" "src/**/*.{ts,tsx}" "playground/**/*.{ts,tsx}"

lint

eslint . --ext .ts,.tsx --cache

lint:fix

npm run lint -- --fix

prepublish-test

scripts/prepublish-test.sh

test

npm run test:unit && npm run test:e2e

test:unit

jest

test:unit:watch

jest --watch

test:update-snapshot

jest --updateSnapshot

test:e2e

npm run bundle && npm run bundle-cli && scripts/build-cli.sh && percy exec -- cypress run

cypress

cypress open

list-licenses

node ./scripts/list-licenses.js

license-check

license-checker --production --onlyAllow 'MIT;ISC;Apache-2.0;Apache;CC0-1.0;BSD;BSD-2-Clause;BSD-3-Clause;UNKNOWN' --summary

ts-check

tsc --noEmit --skipLibCheck

precdn-serve

mkdir -p playground/cdn-test/server-dist && cp -Rf dist/* playground/cdn-test/server-dist && cp -Rf playground/cdn-test/template-source/* playground/cdn-test/server-dist

cdn-serve

http-server playground/cdn-test/server-dist

prepare

husky install
npm i @redocly/reference-docs

Metadata

Downloads