Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix the gulp types task to run on Windows, and place the TypeScript definitions correctly in pdfjs-dist

Browse Source 
- Fix the `gulp types` task to run on Windows. Currently this fails, and the solution was to "borrow" the same formatting as used in the `gulp jsdoc` task.

 - Place the TypeScript definitions in their own `types` directory, when building `pdfjs-dist`. These should *not* be cluttering the main `build` directory, especially since the generated TypeScript definitions consists of *multiple folders*. (Only if the TypeScript definitions would be concatenated into *a single file*, would placing them directly in `pdfjs-dist/build` be acceptable.)
This commit is contained in:
Jonas Jenwald 2020-08-04 11:59:56 +02:00
parent 71f8e1f538
commit fb85c2dc6d
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gulpfile.js
View File

@ -1155,7 +1155,7 @@ gulp.task("types", function (done) {
"forceConsistentCasingInFileNames", "forceConsistentCasingInFileNames",
"emitDeclarationOnly", "emitDeclarationOnly",
].join(" --"); ].join(" --");
exec(`node_modules/.bin/tsc --${args} src/pdf.js`, done); exec(`"node_modules/.bin/tsc" --${args} src/pdf.js`, done);
}); });
function buildLib(defines, dir) { function buildLib(defines, dir) {
@ -1366,7 +1366,9 @@ gulp.task(
SRC_DIR + "pdf.worker.entry.js", SRC_DIR + "pdf.worker.entry.js",
]) ])
.pipe(gulp.dest(TYPESTEST_DIR + "build/")), .pipe(gulp.dest(TYPESTEST_DIR + "build/")),
gulp.src(TYPES_DIR + "**/**").pipe(gulp.dest(TYPESTEST_DIR + "build/")), gulp
.src(TYPES_DIR + "**/*", { base: TYPES_DIR })
.pipe(gulp.dest(TYPESTEST_DIR + "types/")),
]); ]);
}) })
); );
@ -1374,7 +1376,7 @@ gulp.task(
gulp.task( gulp.task(
"typestest", "typestest",
gulp.series("typestest-pre", function (done) { gulp.series("typestest-pre", function (done) {
exec("node_modules/.bin/tsc -p test/types", function (err, stdout) { exec('"node_modules/.bin/tsc" -p test/types', function (err, stdout) {
if (err) { if (err) {
console.log(`Couldn't compile TypeScript test: ${stdout}`); console.log(`Couldn't compile TypeScript test: ${stdout}`);
} }
@ -1625,17 +1627,19 @@ gulp.task(
function packageBowerJson() { function packageBowerJson() {
var VERSION = getVersionJSON().version; var VERSION = getVersionJSON().version;
var DIST_NAME = "pdfjs-dist"; var DIST_NAME = "pdfjs-dist";
var DIST_DESCRIPTION = "Generic build of Mozilla's PDF.js library."; var DIST_DESCRIPTION = "Generic build of Mozilla's PDF.js library.";
var DIST_KEYWORDS = ["Mozilla", "pdf", "pdf.js"]; var DIST_KEYWORDS = ["Mozilla", "pdf", "pdf.js"];
var DIST_HOMEPAGE = "http://mozilla.github.io/pdf.js/"; var DIST_HOMEPAGE = "http://mozilla.github.io/pdf.js/";
var DIST_BUGS_URL = "https://github.com/mozilla/pdf.js/issues"; var DIST_BUGS_URL = "https://github.com/mozilla/pdf.js/issues";
var DIST_LICENSE = "Apache-2.0"; var DIST_LICENSE = "Apache-2.0";
var npmManifest = { var npmManifest = {
name: DIST_NAME, name: DIST_NAME,
version: VERSION, version: VERSION,
main: "build/pdf.js", main: "build/pdf.js",
types: "build/pdf.d.ts", types: "types/pdf.d.ts",
description: DIST_DESCRIPTION, description: DIST_DESCRIPTION,
keywords: DIST_KEYWORDS, keywords: DIST_KEYWORDS,
homepage: DIST_HOMEPAGE, homepage: DIST_HOMEPAGE,
@ -1655,6 +1659,7 @@ function packageBowerJson() {
url: DIST_REPO_URL, url: DIST_REPO_URL,
}, },
}; };
var bowerManifest = { var bowerManifest = {
name: DIST_NAME, name: DIST_NAME,
version: VERSION, version: VERSION,
@ -1747,7 +1752,9 @@ gulp.task(
gulp gulp
.src(LIB_DIR + "**/*", { base: LIB_DIR }) .src(LIB_DIR + "**/*", { base: LIB_DIR })
.pipe(gulp.dest(DIST_DIR + "lib/")), .pipe(gulp.dest(DIST_DIR + "lib/")),
gulp.src(TYPES_DIR + "**/**").pipe(gulp.dest(DIST_DIR + "build/")), gulp
.src(TYPES_DIR + "**/*", { base: TYPES_DIR })
.pipe(gulp.dest(DIST_DIR + "types/")),
]); ]);
} }
) )