dhi/html-import-updater

📦 CLI tool that updates html imports in your web components (or even Polymer elements).

HTML import updater

A cli tool that reads HTML files and updates their script, style or import 'src' or 'href' according to your settings.

Download latest binaries 📀

What is this for?

✅ Polymer projects that change the location of their 3rd party libs
✅ Polymer projects that move to npm
✅ Any project that has a bunch of HTML imports that need to be bulk-updated
✅ Works with nested HTML imports and can exclude paths

Usage (packaged)

Download the latest binary release for your OS on the release page.

Available builds: linux, macos, windows

---

To package the app yourself (essentially create the binaries mentioned above), run

npm run publish:all # creates binaries in ./package

Usage (unpackaged, as a node app)

You can run this tool as a node app or packaged executable.

yarn add html-import-updater # or npm install html-import-updater
cd node_modules/html-import-updater
node ./index.js [options]

# or clone repo and run
node ./index.js [options]

Windows

PowerShell ./html-import-updater.exe [options]

Mac / Linux

./html-import-updater [options]

Options

Usage: index [options]

Options:

  -V, --version             output the version number
  --cwd, --workingDir       Current working directory (where your files
                            are).
  --e, --excludePaths       One or many paths (or globs) you want to
                            exclude, i.e. `-e "prefix-*"`. Can be
                            applied multiple times: `-e "one" -e "two"`.
  --o, --outputDir          The output directory.
  --s, --search             The string you want to search for, i.e. "../"
  --r, --replace            The string you want to replace each     
                            occurrence of the search string with.
  --ep, --excludePatterns   One or many regular expressions that you
                            want to exclude from each matched search
                            item, i.e. `-ep "iron.*"`. Can be applied
                            multiple times: `-ep "one" -ep "two"`.
  -h, --help                output usage information

Developing

The development enviornment has only been used on a macOS & Unix enviornment. Use on Windows at your own risk. The executables from releases (above) should work fine.

Install dependencies

yarn

Run app with babel-node

babel-node index.js [options]

Requires node v8.5.0+

Run a demo

npm run demo # outputs files with replaced locations to ./replaced

Testing

yarn
npm run dev # continuous tests, watches files for changes

Run tests once

npm run test

html-import-updater's Issues

Explainer GIF

Parser & reader shouldn't care about cwd

ATM the pkg has to be in the same dir as the target (--workingDir), but the script shouldn't care about it (i.e. you can target a workingDir one level up).

Test Windows dev enviornment

Should make sure it works.

Add CI to have easily-downloadable execs

For people who don't want to build (or have problems), executables should be offered as an alternative. A straightforward way to make them downloadable is by using a CI service of sorts.