onedeuxtriseigo.nullpo.dev / yomitan
Pop-up dictionary browser extension for language learning. Successor to Yomichan. (PERSONAL FORK)
fork atom
yomitan / docs / development / npm-scripts.md
at lambda-fork/main 4.6 kB view raw view code
Kuuuube Add script for writing anki structured content css (#1706)
4b97a013

npm Scripts#

This file documents the scripts available in the package.json file. Scripts can be executed by running npm run <name>.

  • anki:css-json:write

    Writes Anki structured content styling json for use when sending stuctured content dictionaries to Anki.

    CSS rules are taken from ext/css/structured-content.css and converted into json.

    CSS rule overrides and exclusions can be set in dev/data/structured-content-overrides.css.

  • bench Runs performance benchmarks.

  • build Builds packages for all of the primary build targets and outputs them to the builds folder in the root project directory.

  • build:libs Rebuilds all of the third-party dependencies that the extension uses.

  • build:serve:firefox-android

    adb and web-ext are required to be installed on your computer for this command to work!

    Builds for Firefox and then uses web-ext to serve the extension through adb to Firefox for Android. Prepend the environment variables WEB_EXT_TARGET and WEB_EXT_ADB_DEVICE for the command to succeed (example: WEB_EXT_TARGET="firefox-android" WEB_EXT_ADB_DEVICE="emulator-5554" npm run build:serve:firefox-android). WEB_EXT_TARGET will be "firefox-android" for vanilla Firefox, and you can find the value for WEB_EXT_ADB_DEVICE by running the command adb devices.

    Get started debugging Firefox for Android (recommended)

    web-ext run documentation

  • build:serve:kiwi-browser

    adb is required to be installed on your computer for this command to work!

    Builds for Chromium and then uses adb to push the built zip file over to /sdcard/yomitan. You can then open up Kiwi Browser on the target phone and install the extension through that zip file.

  • test Runs all of the tests.

  • test:fast Runs most of the tests that are used more frequently in the typical development process.

  • test:static-analysis Runs all of the static analysis tests (excluding JSON).

  • test:js Runs eslint on all of the JavaScript and TypeScript files in the project.

  • test:json Runs all JSON tests.

  • test:json:format Runs eslint on all of the JSON files in the project.

  • test:json:types Performs type checking on all of the JSON files in the project. Running this script often takes a long time since it has to validate a lot of files with complex types.

  • test:css Runs stylelint on all of the CSS files in the project.

  • test:html Runs html-validate on all of the HTML files in the project.

  • test:md Runs prettier on all of the Markdown files in the project.

  • test:md:write Uses prettier to fix all issues it encounters with files.

  • test:ts Runs TypeScript validation on all of the JavaScript and TypeScript files in the project.

  • test:ts:main Runs TypeScript validation on the files in the ext folder.

  • test:ts:dev Runs TypeScript validation on the files in the dev folder.

  • test:ts:test Runs TypeScript validation on the files in the test folder.

  • test:ts:bench Runs TypeScript validation on the files in the benches folder.

  • test:unit Runs all of the unit tests in the project using vitest.

  • test:unit:write Overwrites the expected test output data for some of the larger tests. This usually only needs to be run when something modifies the format of dictionary entries or Anki data.

  • test:unit:options Runs unit tests related to the extension's options and their upgrade process.

  • test:build Performs a dry run of the build process without generating any files.

  • license-report:html Generates a file containing license information about the third-party dependencies the extension uses. The resulting file is located at ext/legal-npm.html.

  • license-report:markdown Generates a Markdown table containing license information about the third-party dependencies the extension uses. This table is located in the README.md file

  • prepare Sets up husky for some git pre-commit tasks.