Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.11 KB

Run linting tests

yarn lint # to test
yarn lint:fix # to fix errors

Running in dev mode

# Run the build in watch mode
yarn dev:build

Running this mode rebuilds scrapix on every change made in the source files (./src)

Running the playground

yarn playground:docsearch
yarn playground:default

Running this mode has two effects.

  • If you change the source code of the docusaurus playground, the docusaurus app restarts.
  • If you change the source code of scrapix, scrapix is rebuilded and re-runs a scrapper (either the default one or the docsearch one) on the docusaurus app.

Re-scrap a chosen app on change

If you which to re-scrap an app based on a custom scrapix configuration file, run the following:

npx nodemon --watch src --watch "[PATH_TO_YOUR_CONFIG_FILE]" --ext ts,json --exec "yarn start -c [PATH_TO_YOUR_CONFIG_FILE]"

This will scrap an app based on the provided "PATH_TO_YOUR_CONFIG_FILE" on every change in the ./src folder and on your provided config file.

Publish

To publish scrapix to npm. Increase its version and then:

yarn build
npm publish .