Skip to content

Commit df7190e

Browse files
gfxgfx
authored
Merge pull request #140 from msgpack/tree-shakable
Tree Shakable package
2 parents f28e981 + 7f3416f commit df7190e

File tree

7 files changed

+172
-1
lines changed

7 files changed

+172
-1
lines changed

‎example/webpack-example/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock.json

‎example/webpack-example/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Webpack Example for @msgpack/msgpack
2+
3+
This example demonstrates tree-shaking with webpack.
4+
5+
## Usage
6+
7+
```shell
8+
npm install
9+
npx webpack
10+
ls -lh dist/
11+
```

‎example/webpack-example/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import { encode } from "@msgpack/msgpack";
2+
3+
console.log(encode(null));
4+

‎example/webpack-example/package.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "webpack-example",
3+
"version": "1.0.0",
4+
"description": "",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"author": "",
10+
"license": "ISC",
11+
"dependencies": {
12+
"@msgpack/msgpack": "../../"
13+
},
14+
"devDependencies": {
15+
"lodash": "^4.17.20",
16+
"ts-loader": "^8.0.4",
17+
"ts-node": "^9.0.0",
18+
"typescript": "^4.0.3",
19+
"webpack": "^4.44.2",
20+
"webpack-cli": "^3.3.12"
21+
}
22+
}

‎example/webpack-example/tsconfig.json

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Basic Options */
6+
// "incremental": true, /* Enable incremental compilation */
7+
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
8+
"module": "es2020", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9+
// "lib": [], /* Specify library files to be included in the compilation. */
10+
// "allowJs": true, /* Allow javascript files to be compiled. */
11+
// "checkJs": true, /* Report errors in .js files. */
12+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
13+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
14+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15+
// "sourceMap": true, /* Generates corresponding '.map' file. */
16+
// "outFile": "./", /* Concatenate and emit output to single file. */
17+
// "outDir": "./", /* Redirect output structure to the directory. */
18+
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19+
// "composite": true, /* Enable project compilation */
20+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21+
// "removeComments": true, /* Do not emit comments to output. */
22+
// "noEmit": true, /* Do not emit outputs. */
23+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
26+
27+
/* Strict Type-Checking Options */
28+
"strict": true, /* Enable all strict type-checking options. */
29+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30+
// "strictNullChecks": true, /* Enable strict null checks. */
31+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36+
37+
/* Additional Checks */
38+
// "noUnusedLocals": true, /* Report errors on unused locals. */
39+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
42+
43+
/* Module Resolution Options */
44+
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
45+
"baseUrl": "./", /* Base directory to resolve non-absolute module names. */
46+
"paths": {
47+
"@msgpack/msgpack": ["../../"]
48+
}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
49+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
50+
// "typeRoots": [], /* List of folders to include type definitions from. */
51+
// "types": [], /* Type declaration files to be included in compilation. */
52+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
53+
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
54+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
55+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
56+
57+
/* Source Map Options */
58+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
59+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
61+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
62+
63+
/* Experimental Options */
64+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
65+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
66+
67+
/* Advanced Options */
68+
"skipLibCheck": true, /* Skip type checking of declaration files. */
69+
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
70+
}
71+
}

‎example/webpack-example/webpack.config.ts

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
const path = require("path");
2+
const webpack = require("webpack");
3+
const _ = require("lodash");
4+
5+
const config = {
6+
mode: "production",
7+
8+
entry: "./index.ts",
9+
output: {
10+
path: path.resolve(__dirname, "dist"),
11+
filename: undefined, // will be set later
12+
},
13+
resolve: {
14+
extensions: [".ts", ".tsx", ".mjs", ".js", ".json", ".wasm"],
15+
},
16+
module: {
17+
rules: [
18+
{
19+
test: /\.tsx?$/,
20+
loader: "ts-loader",
21+
options: {
22+
configFile: "tsconfig.json",
23+
},
24+
},
25+
],
26+
},
27+
28+
plugins: [
29+
new webpack.DefinePlugin({
30+
// eslint-disable-next-line @typescript-eslint/naming-convention
31+
"process.env.TEXT_ENCODING": "undefined",
32+
// eslint-disable-next-line @typescript-eslint/naming-convention
33+
"process.env.TEXT_DECODER": "undefined",
34+
}),
35+
],
36+
37+
optimization: {
38+
noEmitOnErrors: true,
39+
minimize: false,
40+
},
41+
42+
// We don't need NodeJS stuff on browsers!
43+
// https://webpack.js.org/configuration/node/
44+
node: false,
45+
46+
devtool: "source-map",
47+
};
48+
49+
module.exports = [
50+
((config) => {
51+
config.output.filename = "bundle.min.js";
52+
config.optimization.minimize = true;
53+
return config;
54+
})(_.cloneDeep(config)),
55+
56+
((config) => {
57+
config.output.filename = "bundle.js";
58+
config.optimization.minimize = false;
59+
return config;
60+
})(_.cloneDeep(config)),
61+
];

‎package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
"author": "The MessagePack community",
66
"license": "ISC",
77
"main": "./dist/index.js",
8-
"browser": "./dist.es5+umd/msgpack.min.js",
98
"module": "./dist.es5+esm/index.js",
9+
"cdn": "./dist.es5+umd/msgpack.min.js",
10+
"unpkg": "./dist.es5+umd/msgpack.min.js",
1011
"types": "./dist/index.d.ts",
1112
"sideEffects": false,
1213
"scripts": {

0 commit comments

Comments
 (0)