polymer2-migrator v1.2.0

polymer2-migrator

:warning: Important: this project is still a WIP and highly experimental.

Migrates a Polymer 1.x component to Polymer 2.x component (class based).

Installation

npm install -g polymer2-migrator

Usage

migrate-component [<folder>|<file>] [--analysis] [--log-level=level]

Examples:

migrate-component
migrate-component ./src
migrate-component file_1.html file_2.html --analysis
migrate-component --log-level=verbose

Options

analysis

If the --analysis flag is used, the migrator will only analyze the component to check which migrations are possible, and generate a migrator-analysis file. It will not make any changes in the component's files.

log-level

Defines the log level of the console output.

Available values: error, warn, info, verbose, debug.

How does it work?

The polymer2-migrator applies the following changes to upgrade your Polymer 1.x component to Polymer 2.x class-based component:

DOM template

• :white_check_mark: Remove deprecated patterns in the DOM module: <dom-module> using is or name.
• :white_circle: Remove deprecated patterns in the DOM module: styles outside of the template.
• :white_check_mark: Update your element's DOM template to use the new <slot> element instead of <content>.
• :white_circle: Update any URLs inside the template.

Source

Shadow DOM styles

• :white_check_mark: Replace ::content selectors with ::slotted() selectors.
• :white_check_mark: Remove /deep/ and ::shadow selectors, if you're still using them.
• :white_check_mark: Remove :root selectors.
• :white_check_mark: Update custom property syntax.
• :white_check_mark: Wrap custom-style elements.

Source

DOM APIs

• :white_check_mark: Convert to class syntax.
• :white_check_mark: Add listeners to ready function.
• :white_check_mark: Behaviors as mixins.
• :white_check_mark: Automatically import dom-if.html and dom-repeat.html if needed.

Source

Common utility APIs

• :white_check_mark: fire - Replaces the fire method with dispatchEvent and adapts the syntax.
• :white_circle: async
• :white_circle: debounce
• :white_circle: importHref
• :white_check_mark: $$ - Replaces the $$('selector') syntax with shadowRoot.querySelector('selector').

Source

Additional Features

• Analysis file: Generates a verbose log file showing all the applied changes to each file.
• ...