Customize template repository

[hansregeer]

npm packages

• Configure npm organization in .npmpackagejsonlintrc.json (replace @example in valid-values-name-scope), and replace @example in every package.json and package-lock.json with find-and-replace. Use npm run lint:package-json and npm ls to check if you missed anything.
• Replace the @example/ reference in imports in every .js/.jsx/.ts/.tsx file with your scope
• Replace the @example/ reference in the packages/web-components-stencil/stencil.config.ts file with your scope
• Update the "repository" field of every package.json file with the URL of your repository. The SSH URL is preferred over the HTTPS URL.
• Optional: mention the name of your organisation in the "description" field of every package.json file.

CSS prefix

• Configure class name prefix in .stylelintrc.json with selector-class-pattern and replace example with your own prefix.
• Configure CSS keyframe prefix in .stylelintrc.json with keyframes-name-pattern and replace example with your own prefix.
• Configure custom CSS property prefix in .stylelintrc.json with custom-property-pattern and replace example with your own prefix.
• Configure custom SCSS variable prefix in .stylelintrc.json with scss/dollar-variable-pattern and replace example with your own prefix.
• Configure custom SCSS placeholder prefix in .stylelintrc.json with scss/percent-placeholder-pattern and replace example with your own prefix.
• Configure the CSS class name prefix by updating proprietary/design-tokens/style-dictionary.config.json and example in "selector": ".example-theme" with your own prefix.

Design tokens

• Configure the design token property prefix in every *.tokens.json:
  • replace { "example": {} } root property with your own prefix.
  • replace every instance of example in design token references with your own prefix, look for every instance of {example. in *.tokens.json.
• Rename directory example/ in proprietary/design-tokens/src/brand/example/ to your own prefix.

Documentation

• Configure your organisation name in documentation files:
• Heading of README.md
• Every instance of {author} in LICENSE.md files (as well as {year} for copyright)