Typescript bundling format for dependencies of addons

Scott_Newcomer · January 13, 2019, 1:54am

Open ended question - here is a Typescript dependency that I have included in a few addons. It is very simple. Publishes a umd format dist and that is it. Is there anything else I should be considering when building Typescript libraries for the Ember (and other) ecosystem? Sorry for the lack of specificity but looking to build a source of information / examples to help others.

github.com

snewcomer/raf-pool/blob/v0.0.4/rollup.config.ts#L13


      
          import resolve from 'rollup-plugin-node-resolve';
          import sourceMaps from 'rollup-plugin-sourcemaps';
          
          
const pkg = require('./package.json');
          const libraryName = 'raf-pool';
          
          
export default {
            external: [],
            input: `dist/es/index.js`,
            output: [
              { file: pkg.main, name: camelCase(libraryName), format: 'umd' }
            ],
            plugins: [
              // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs)
              commonjs(),
              // Allow node_modules resolution, so you can use 'external' to control
              // which external modules to include in the bundle
              // https://github.com/rollup/rollup-plugin-node-resolve#usage
              resolve(),
          
          
    // Resolve source maps to the original source

github.com

snewcomer/raf-pool/blob/v0.0.4/tsconfig.json#L6


      
          {
            "compilerOptions": {
              /* Basic Options */
              "moduleResolution": "node",
              "target": "ES5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
              "module": "umd", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
              // "lib": [],                             /* Specify library files to be included in the compilation. */
              // "allowJs": true,                       /* Allow javascript files to be compiled. */
              // "checkJs": true,                       /* Report errors in .js files. */
              // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
              "declaration": true, /* Generates corresponding '.d.ts' file. */
              "declarationDir": "dist/types",
              // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
              "stripInternal": true,
              "sourceMap": true, /* Generates corresponding '.map' file. */
              // "outFile": "./",                       /* Concatenate and emit output to single file. */

Scott_Newcomer · January 13, 2019, 6:12am

Ok got a small PR going. Keeps es format when first bundling with typescript and available under pkg.json “module” field.

Topic		Replies	Views
Module parse failed: Unexpected token Emberjs Build Issues	0	1219	October 19, 2022
Readers’ Questions - “How far are we from being able to just use any npm package via the import statement?” Learning Team	2	2234	September 29, 2018
TypeScript package for ember app? Learning Team	4	1354	June 13, 2017
Is there a discussion/direction around Ember + Rollup for svelte builds?	5	1637	September 11, 2017
Importing a Commonjs TypeScript Library with Embroider Build Issues	10	313	May 14, 2024

Typescript bundling format for dependencies of addons

Related topics