Skip to content

Commit

Permalink
[api-minor] Produce non-translated/non-polyfilled builds by default
Browse files Browse the repository at this point in the history
  • Loading branch information
Snuffleupagus committed Feb 11, 2020
1 parent 10be099 commit c7daeb8
Show file tree
Hide file tree
Showing 9 changed files with 166 additions and 42 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ Feel free to stop by #pdfjs on irc.mozilla.org for questions or guidance.

### Online demo

+ https://mozilla.github.io/pdf.js/web/viewer.html
+ Modern browsers: https://mozilla.github.io/pdf.js/web/viewer.html

+ Older browsers: https://mozilla.github.io/pdf.js/es5/web/viewer.html

### Browser Extensions

Expand Down
19 changes: 16 additions & 3 deletions docs/contents/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,33 @@ Before downloading PDF.js please take a moment to understand the different layer
## Download

<div class="row">
<div class="col-md-6">
<div class="col-md-4">
<h3>Prebuilt</h3>
<p>
Includes the generic build of PDF.js and the viewer.
</p>
<!--
<span class="GROUP_CLASS">
<a type="button" class="btn btn-primary" href="https://github.com/mozilla/pdf.js/releases/download/vSTABLE_VERSION/pdfjs-STABLE_VERSION-dist.zip">Stable (vSTABLE_VERSION)</a>
<a type="button" class="btn btn-warning HIDDEN_CLASS" href="https://github.com/mozilla/pdf.js/releases/download/vBETA_VERSION/pdfjs-BETA_VERSION-dist.zip">Beta (vBETA_VERSION)</a>
</span>
-->
</div>
<div class="col-md-6">
<div class="col-md-4">
<h3>Prebuilt (ES5-compatible)</h3>
<p>
Includes the generic build of PDF.js and the viewer.
</p>
<span class="GROUP_CLASS">
<a type="button" class="btn btn-primary" href="https://github.com/mozilla/pdf.js/releases/download/vSTABLE_VERSION/pdfjs-STABLE_VERSION-dist.zip">Stable (vSTABLE_VERSION)</a>
<a type="button" class="btn btn-warning HIDDEN_CLASS" href="https://github.com/mozilla/pdf.js/releases/download/vBETA_VERSION/pdfjs-BETA_VERSION-dist.zip">Beta (vBETA_VERSION)</a>
</span>
</span>
</div>
<div class="col-md-4">
<h3>Source</h3>
To get a local copy of the current code, clone it using git:
<pre><code>$ git clone git://github.com/mozilla/pdf.js.git
<pre><code>$ git clone https://github.com/mozilla/pdf.js.git
$ cd pdf.js
</code></pre>
</div>
Expand Down
2 changes: 1 addition & 1 deletion examples/node/getinfo.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//

// Run `gulp dist-install` to generate 'pdfjs-dist' npm package files.
var pdfjsLib = require("pdfjs-dist");
var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");

// Loading file from file system into typed array
var pdfPath = process.argv[2] || "../../web/compressed.tracemonkey-pldi-09.pdf";
Expand Down
2 changes: 1 addition & 1 deletion examples/node/pdf2png/pdf2png.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ NodeCanvasFactory.prototype = {
},
};

var pdfjsLib = require("pdfjs-dist");
var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");

// Relative path of the PDF file.
var pdfURL = "../../../web/compressed.tracemonkey-pldi-09.pdf";
Expand Down
2 changes: 1 addition & 1 deletion examples/node/pdf2svg.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ var stream = require("stream");
require("./domstubs.js").setStubs(global);

// Run `gulp dist-install` to generate 'pdfjs-dist' npm package files.
var pdfjsLib = require("pdfjs-dist");
var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");

// Loading file from file system into typed array
var pdfPath = process.argv[2] || "../../web/compressed.tracemonkey-pldi-09.pdf";
Expand Down
4 changes: 4 additions & 0 deletions external/dist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ parsing and rendering PDFs.
This is a pre-built version of the PDF.js source code. It is automatically
generated by the build scripts.

For usage with older browsers/environments, without support for modern features
such as e.g. `async`/`await`, `Promise`, and `ReadableStream`,
please refer to the `es5` folder.

See https://github.com/mozilla/pdf.js for learning and contributing.
167 changes: 135 additions & 32 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ var EXTENSION_SRC_DIR = "extensions/";
var BASELINE_DIR = BUILD_DIR + "baseline/";
var MOZCENTRAL_BASELINE_DIR = BUILD_DIR + "mozcentral.baseline/";
var GENERIC_DIR = BUILD_DIR + "generic/";
var GENERIC_ES5_DIR = BUILD_DIR + "generic-es5/";
var COMPONENTS_DIR = BUILD_DIR + "components/";
var COMPONENTS_ES5_DIR = BUILD_DIR + "components-es5/";
var IMAGE_DECODERS_DIR = BUILD_DIR + "image_decoders";
var DEFAULT_PREFERENCES_DIR = BUILD_DIR + "default_preferences/";
var MINIFIED_DIR = BUILD_DIR + "minified/";
Expand Down Expand Up @@ -90,6 +92,7 @@ var CSS_VARIABLES_CONFIG = {

var DEFINES = {
PRODUCTION: true,
SKIP_BABEL: true,
TESTING: false,
// The main build targets:
GENERIC: false,
Expand All @@ -98,7 +101,6 @@ var DEFINES = {
MINIFIED: false,
COMPONENTS: false,
LIB: false,
SKIP_BABEL: false,
IMAGE_DECODERS: false,
};

Expand Down Expand Up @@ -180,8 +182,7 @@ function createWebpackConfig(defines, output) {
!bundleDefines.MOZCENTRAL &&
!bundleDefines.CHROME &&
!bundleDefines.TESTING;
var skipBabel =
bundleDefines.SKIP_BABEL || process.env["SKIP_BABEL"] === "true";
var skipBabel = bundleDefines.SKIP_BABEL;

// Required to expose e.g., the `window` object.
output.globalObject = "this";
Expand Down Expand Up @@ -737,8 +738,8 @@ function preprocessHTML(source, defines) {
return createStringSource(source.substr(i + 1), out);
}

// Builds the generic production viewer that should be compatible with most
// modern HTML5 browsers.
// Builds the generic production viewer that is only compatible with up-to-date
// HTML5 browsers, which implements modern ECMAScript features.
gulp.task(
"generic",
gulp.series("buildnumber", "default_preferences", "locale", function() {
Expand Down Expand Up @@ -786,6 +787,49 @@ gulp.task(
})
);

// Builds the generic production viewer that should be compatible with most
// older HTML5 browsers.
gulp.task(
"generic-es5",
gulp.series("buildnumber", "default_preferences", "locale", function() {
console.log();
console.log("### Creating generic (ES5) viewer");
var defines = builder.merge(DEFINES, { GENERIC: true, SKIP_BABEL: false });

rimraf.sync(GENERIC_ES5_DIR);

return merge([
createBundle(defines).pipe(gulp.dest(GENERIC_ES5_DIR + "build")),
createWebBundle(defines).pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
gulp
.src(COMMON_WEB_FILES, { base: "web/" })
.pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
gulp.src("LICENSE").pipe(gulp.dest(GENERIC_ES5_DIR)),
gulp
.src(
["web/locale/*/viewer.properties", "web/locale/locale.properties"],
{ base: "web/" }
)
.pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
gulp
.src(["external/bcmaps/*.bcmap", "external/bcmaps/LICENSE"], {
base: "external/bcmaps",
})
.pipe(gulp.dest(GENERIC_ES5_DIR + "web/cmaps")),
preprocessHTML("web/viewer.html", defines).pipe(
gulp.dest(GENERIC_ES5_DIR + "web")
),
preprocessCSS("web/viewer.css", "generic", defines, true)
.pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)]))
.pipe(gulp.dest(GENERIC_ES5_DIR + "web")),

gulp
.src("web/compressed.tracemonkey-pldi-09.pdf")
.pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
]);
})
);

gulp.task(
"components",
gulp.series("buildnumber", function() {
Expand Down Expand Up @@ -818,6 +862,38 @@ gulp.task(
})
);

gulp.task(
"components-es5",
gulp.series("buildnumber", function() {
console.log();
console.log("### Creating generic (ES5) components");
var defines = builder.merge(DEFINES, {
COMPONENTS: true,
GENERIC: true,
SKIP_BABEL: false,
});

rimraf.sync(COMPONENTS_ES5_DIR);

var COMPONENTS_IMAGES = [
"web/images/annotation-*.svg",
"web/images/loading-icon.gif",
"web/images/shadow.png",
"web/images/texture.png",
];

return merge([
createComponentsBundle(defines).pipe(gulp.dest(COMPONENTS_ES5_DIR)),
gulp
.src(COMPONENTS_IMAGES)
.pipe(gulp.dest(COMPONENTS_ES5_DIR + "images")),
preprocessCSS("web/pdf_viewer.css", "components", defines, true)
.pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)]))
.pipe(gulp.dest(COMPONENTS_ES5_DIR)),
]);
})
);

gulp.task(
"image_decoders",
gulp.series("buildnumber", function() {
Expand Down Expand Up @@ -981,10 +1057,7 @@ gulp.task(
gulp.series("buildnumber", "default_preferences", function() {
console.log();
console.log("### Building mozilla-central extension");
var defines = builder.merge(DEFINES, {
MOZCENTRAL: true,
SKIP_BABEL: true,
});
var defines = builder.merge(DEFINES, { MOZCENTRAL: true });

var MOZCENTRAL_DIR = BUILD_DIR + "mozcentral/",
MOZCENTRAL_EXTENSION_DIR = MOZCENTRAL_DIR + "browser/extensions/pdfjs/",
Expand Down Expand Up @@ -1045,7 +1118,7 @@ gulp.task(
gulp.series("buildnumber", "default_preferences", "locale", function() {
console.log();
console.log("### Building Chromium extension");
var defines = builder.merge(DEFINES, { CHROME: true });
var defines = builder.merge(DEFINES, { CHROME: true, SKIP_BABEL: false });

var CHROME_BUILD_DIR = BUILD_DIR + "/chromium/",
CHROME_BUILD_CONTENT_DIR = CHROME_BUILD_DIR + "/content/";
Expand Down Expand Up @@ -1144,7 +1217,7 @@ gulp.task(
}
function preprocess(content) {
var skipBabel =
process.env["SKIP_BABEL"] === "true" ||
bundleDefines.SKIP_BABEL ||
/\/\*\s*no-babel-preset\s*\*\//.test(content);
content = preprocessor2.preprocessPDFJSCode(ctx, content);
content = babel.transform(content, {
Expand Down Expand Up @@ -1173,16 +1246,17 @@ gulp.task(
}
var babel = require("@babel/core");
var versionInfo = getVersionJSON();
var bundleDefines = builder.merge(DEFINES, {
GENERIC: true,
LIB: true,
BUNDLE_VERSION: versionInfo.version,
BUNDLE_BUILD: versionInfo.commit,
TESTING: process.env["TESTING"] === "true",
});
var ctx = {
rootPath: __dirname,
saveComments: false,
defines: builder.merge(DEFINES, {
GENERIC: true,
LIB: true,
BUNDLE_VERSION: versionInfo.version,
BUNDLE_BUILD: versionInfo.commit,
TESTING: process.env["TESTING"] === "true",
}),
defines: bundleDefines,
map: {
"pdfjs-lib": "../pdf",
},
Expand Down Expand Up @@ -1213,27 +1287,38 @@ gulp.task(

gulp.task(
"publish",
gulp.series("generic", function(done) {
gulp.series("generic", "generic-es5", function(done) {
var version = JSON.parse(
fs.readFileSync(BUILD_DIR + "version.json").toString()
).version;

config.stableVersion = config.betaVersion;
config.betaVersion = version;

createStringSource(CONFIG_FILE, JSON.stringify(config, null, 2))
.pipe(gulp.dest("."))
.on("end", function() {
var targetName = "pdfjs-" + version + "-dist.zip";
gulp
.src(BUILD_DIR + "generic/**")
.pipe(zip(targetName))
.pipe(gulp.dest(BUILD_DIR))
.on("end", function() {
console.log("Built distribution file: " + targetName);
done();
});
});
var targetName = "pdfjs-" + version + "-dist.zip";
var targetNameES5 = "pdfjs-" + version + "-es5-dist.zip";

return merge([
createStringSource(CONFIG_FILE, JSON.stringify(config, null, 2)).pipe(
gulp.dest(".")
),

gulp
.src(GENERIC_DIR + "**")
.pipe(zip(targetName))
.pipe(gulp.dest(BUILD_DIR))
.on("end", function() {
console.log("Built distribution file: " + targetName);
}),

gulp
.src(GENERIC_ES5_DIR + "**")
.pipe(zip(targetNameES5))
.pipe(gulp.dest(BUILD_DIR))
.on("end", function() {
console.log("Built distribution file: " + targetNameES5);
}),
]);
})
);

Expand Down Expand Up @@ -1446,6 +1531,9 @@ gulp.task("gh-pages-prepare", function() {
vfs
.src(GENERIC_DIR + "**/*", { base: GENERIC_DIR, stripBOM: false })
.pipe(gulp.dest(GH_PAGES_DIR)),
vfs
.src(GENERIC_ES5_DIR + "**/*", { base: GENERIC_ES5_DIR, stripBOM: false })
.pipe(gulp.dest(GH_PAGES_DIR + "es5/")),
gulp
.src("test/features/**/*", { base: "test/" })
.pipe(gulp.dest(GH_PAGES_DIR)),
Expand Down Expand Up @@ -1524,6 +1612,7 @@ gulp.task(
"web",
gulp.series(
"generic",
"generic-es5",
"jsdoc",
"gh-pages-prepare",
"wintersmith",
Expand All @@ -1535,7 +1624,9 @@ gulp.task(
"dist-pre",
gulp.series(
"generic",
"generic-es5",
"components",
"components-es5",
"image_decoders",
"lib",
"minified",
Expand Down Expand Up @@ -1617,6 +1708,15 @@ gulp.task(
SRC_DIR + "pdf.worker.entry.js",
])
.pipe(gulp.dest(DIST_DIR + "build/")),
gulp
.src([
GENERIC_ES5_DIR + "build/pdf.js",
GENERIC_ES5_DIR + "build/pdf.js.map",
GENERIC_ES5_DIR + "build/pdf.worker.js",
GENERIC_ES5_DIR + "build/pdf.worker.js.map",
SRC_DIR + "pdf.worker.entry.js",
])
.pipe(gulp.dest(DIST_DIR + "es5/build/")),
gulp
.src(MINIFIED_DIR + "build/pdf.js")
.pipe(rename("pdf.min.js"))
Expand All @@ -1632,6 +1732,9 @@ gulp.task(
gulp
.src(COMPONENTS_DIR + "**/*", { base: COMPONENTS_DIR })
.pipe(gulp.dest(DIST_DIR + "web/")),
gulp
.src(COMPONENTS_ES5_DIR + "**/*", { base: COMPONENTS_ES5_DIR })
.pipe(gulp.dest(DIST_DIR + "es5/web/")),
gulp
.src(IMAGE_DECODERS_DIR + "**/*", { base: IMAGE_DECODERS_DIR })
.pipe(gulp.dest(DIST_DIR + "image_decoders")),
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"yargs": "^11.1.1"
},
"scripts": {
"test": "env SKIP_BABEL=true gulp npm-test"
"test": "gulp npm-test"
},
"repository": {
"type": "git",
Expand Down
Loading

0 comments on commit c7daeb8

Please sign in to comment.