dart-lang/dart-doc-syncer

Name: dart-doc-syncer

Owner: Dart

Description: A utility for syncing Dart examples for the public docs

Created: 2016-03-08 22:17:37.0

Updated: 2018-05-03 10:48:39.0

Pushed: 2018-05-24 11:28:19.0

Homepage:

Size: 124

Language: Dart

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

dart-doc-syncer

A utility for syncing Dart examples for the AngularDart docs (https://webdev.dartlang.org/angular).

Example sources are read from the dart-lang/site-webdev repo and written to individual repos under angular-examples.

Syncing a single example

Use the example name as an argument. For example:

 dart_doc_syncer architecture

Syncing multiple examples

The --match option takes a regular expression as an argument. The dart_doc_syncer will sync all examples that match the regex. To sync all examples, you can use . (dot) as a “match-all” pattern:

 dart_doc_syncer --match .

Options

 ~/GITHUB/dart-doc-syncer/bin/dart_doc_syncer.dart --help

s Angular docs example apps.

e: dart_doc_syncer [options] [<exampleName> | <examplePath> <exampleRepo>]

--help                Show this usage information
--branch              <branch-name>
                      Git branch to fetch webdev and examples from
                      (defaults to "master")

--dry-run             Show which commands would be executed but make (almost) no changes;
                      only the temporary directory will be created

--force-build         Forces build of example app when sources have not changed
--gh-pages-app-dir    <path>
                      Directory in which the generated example apps will be placed (gh-pages branch)

--keep-tmp            Do not delete temporary working directory once done
--pub-get             Use `pub get` instead of `pub upgrade` before building apps
--[no-]push           Prepare updates and push to example repo
                      (defaults to on)

--match               <dart-regexp>
                      Sync all examples having a data file (.docsync.json)
                      and whose repo path matches the given regular expression;
                      use "." to match all

--skip                <dart-regexp>
                      Negative filter applied to the project list created by use of the --match option

--url                 [dev|main]
                      Webdev site URL to use in generated README.
                      (defaults to "main")

--user                <user-id>
                      GitHub id of repo to fetch examples from
                      (defaults to "dart-lang")

--verbose             
--web-compiler        <compiler>, either dart2js or dartdevc
                      (defaults to "dart2js")

--work-dir            <path>
                      Path to a working directory; when unspecified a system-generated path to a temporary directory is used