Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 2fcda45

Browse files
chalinkwalrath
authored andcommitted
chore(api): Dart API source folders renamed (#2181)
- angular2 dartdoc files will be in `doc/api` - angular2 site examples will be in `example`
1 parent aa439d2 commit 2fcda45

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

gulpfile.js

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ var _apiShredOptions = {
7272
logLevel: _dgeniLogLevel
7373
};
7474

75+
const relDartDocApiDir = path.join('doc', 'api');
7576
var _apiShredOptionsForDart = {
7677
lang: 'dart',
77-
examplesDir: path.resolve(ngPathFor('dart'), 'examples'),
78+
examplesDir: path.resolve(ngPathFor('dart'), 'example'),
7879
fragmentsDir: path.join(DOCS_PATH, '_fragments/_api'),
7980
zipDir: path.join(RESOURCES_PATH, 'zips/api'),
8081
logLevel: _dgeniLogLevel
@@ -346,6 +347,7 @@ function runE2eDartTests(appDir, outputFile) {
346347
}
347348
if (argv.pub === false) {
348349
var prepPromise = Promise.resolve(true);
350+
gutil.log('Skipping pub upgrade and pub build (--no-pub flag present)');
349351
} else {
350352
var pubUpgradeSpawnInfo = spawnExt('pub', ['upgrade'], { cwd: appDir });
351353
var prepPromise = pubUpgradeSpawnInfo.promise.then(function (data) {
@@ -608,8 +610,8 @@ gulp.task('build-dart-cheatsheet', [], function() {
608610

609611
gulp.task('dartdoc', ['pub upgrade'], function() {
610612
const ngRepoPath = ngPathFor('dart');
611-
if (argv.fast && fs.existsSync(path.resolve(ngRepoPath, 'docs', 'api'))) {
612-
gutil.log('Skipping dartdoc: --fast flag enabled and "docs/api" dir exists');
613+
if (argv.fast && fs.existsSync(path.resolve(ngRepoPath, relDartDocApiDir))) {
614+
gutil.log(`Skipping dartdoc: --fast flag enabled and api dir exists (${relDartDocApiDir})`);
613615
return true;
614616
}
615617
checkAngularProjectPath(ngRepoPath);
@@ -618,7 +620,7 @@ gulp.task('dartdoc', ['pub upgrade'], function() {
618620
renameIfExistsSync(topLevelLibFilePath, tmpPath);
619621
gutil.log(`Hiding top-level angular2 library: ${topLevelLibFilePath}`);
620622
// Remove dartdoc '--add-crossdart' flag while we are fixing links to API pages.
621-
const dartdoc = spawnExt('dartdoc', ['--output', 'docs/api'], { cwd: ngRepoPath});
623+
const dartdoc = spawnExt('dartdoc', ['--output', relDartDocApiDir], { cwd: ngRepoPath});
622624
return dartdoc.promise.finally(() => {
623625
gutil.log(`Restoring top-level angular2 library: ${topLevelLibFilePath}`);
624626
renameIfExistsSync(tmpPath, topLevelLibFilePath);
@@ -1246,7 +1248,7 @@ function buildApiDocsForDart() {
12461248
log.level = _dgeniLogLevel;
12471249
const dabInfo = dab.dartPkgConfigInfo;
12481250
dabInfo.ngIoDartApiDocPath = path.join(DOCS_PATH, 'dart', vers, 'api');
1249-
dabInfo.ngDartDocPath = path.join(ngPathFor('dart'), 'docs', 'api');
1251+
dabInfo.ngDartDocPath = path.join(ngPathFor('dart'), relDartDocApiDir);
12501252
// Exclude API entries for developer/internal libraries. Also exclude entries for
12511253
// the top-level catch all "angular2" library (otherwise every entry appears twice).
12521254
dabInfo.excludeLibRegExp = new RegExp(/^(?!angular2)|\.testing|_|codegen|^angular2$/);

tools/api-builder/dart-package/test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const apiDocPath = path.join(DOCS_PATH, 'dart/latest/api');
1414

1515
dartPkg.config(function (dartPkgConfigInfo) {
1616
dartPkgConfigInfo.ngIoDartApiDocPath = apiDocPath;
17-
dartPkgConfigInfo.ngDartDocPath = path.join(ANGULAR_IO_PROJECT_PATH, '../angular-dart/docs/api');
17+
dartPkgConfigInfo.ngDartDocPath = path.join(ANGULAR_IO_PROJECT_PATH, '../angular-dart/doc/api');
1818
});
1919

2020
const dgeni = new Dgeni([dartPkg]);

0 commit comments

Comments
 (0)