README.md

template-sync

Keep repository in sync with its template.

Generates pull requests to bring a repository back in sync with its template.

So by making changes to the template and applying template-sync the target project will be updated accoring to the template.

Works with github and bitbucket.

This is the engine for cli operation please see template-tools/template-sync-cli

Merges contents from template branch into destination branch handling some special cases for:

• Licenses - rewriting license years
• line set files like .npmignore and .gitignore - by merging both sets together
• package.json - merge (.*)[Dd]ependencies, engines and scripts
• rollup.conf.*js - copy / rewrite + detect dev dependencies
• *.yaml - merge
• .travis.yml - merge with hints
• *.toml - merge
• *.ini - merge
• *.json - merge
• README.md - merge badges

Some templates

• arlac77/template-cli-app rollup ava travis
• arlac77/template-esm-only ava travis
• arlac77/template-svelte-component svelte rollup testcafe travis
• arlac77/template-svelte-app svelte rollup pkgbuild travis
• arlac77/template-kronos-component template-esm-only with node 14
• arlac77/template-kronos-app node 14 + systemd

API

Table of Contents

• Delete
• Merger
  • properties
    • Parameters
  • commits
    • Parameters
• INI
• normalizeTemplateSources
  • Parameters
• jspath
  • Parameters
• actions2message
  • Parameters
• actions2messages
  • Parameters
• MergeLineSet
• sortedKeys
• exportsConditionOrder
• Package
  • properties
    • Parameters
• Readme
• ReplaceIfEmpty
• Replace
• Skip

Delete

Extends Merger

Delete entry.

Merger

Mergable content

properties

Deliver some key properties.

Parameters

• entry ContentEntry

Returns Object extracted properties

commits

Generate commits as result of merging two entries.

Parameters

• context
• destinationEntry
• sourceEntry
• options

INI

Extends Merger

Merge ini entries

normalizeTemplateSources

Remove duplicate sources. Sources staring with '-' will be removed

Parameters

• sources Array<string>
• remove Array<string> (optional, default [])

Returns Array<string> normalized sources

jspath

Parameters

• object
• path
• cb

actions2message

Parameters

• actions
• prefix string
• name string

Returns any actions as one string lines ordered by scope

actions2messages

Parameters

• actions
• prefix string
• name string

MergeLineSet

Extends Merger

sortedKeys

order in which json keys are written

exportsConditionOrder

• See: {https://nodejs.org/dist/latest/docs/api/packages.html#exports}

Order in which exports are searched

Package

Extends Merger

Merger for package.json

properties

Deliver some key properties.

• name
• version
• description
• main

Parameters

• entry ContentEntry

Returns Promise<Object>

Readme

Extends Merger

Injects badges into README.md.

ReplaceIfEmpty

Extends Merger

Overwrites none existing entries from template.

Replace

Extends Merger

Always overwrite entry from template

Skip

Extends Merger

Does not generate destination entry

install

With npm do:

npm install -g @template-tools/sync-cli

license

BSD-2-Clause