Nacho Portion Monitor

    @appnest/web-config
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.4 • Public • Published

    @appnest/web-config

    Downloads per month NPM Version Dependencies Contributors

    A Rollup configuration to help you build modern web applications. The configuration works extremely well with the libraries lit-html and lit-element. I wanted to share it so you can use it too or build on top of it.


    -----------------------------------------------------

    ➤ Table of Contents

    -----------------------------------------------------

    ➤ Step 1 - Installation

    The fastest way to get started is to use the CLI. Run the following command to setup your project from scratch. If you choose to use the CLI you can skip the rest of the steps in this README file.

    $ npm init web-config new <dir>

    To use it in your project you can install it like this.

    $ npm i @appnest/web-config --D

    -----------------------------------------------------

    ➤ Step 2 - Setup rollup.config.ts

    Here's an example on what your Rollup configuration file could look like:

    import {resolve, join} from "path";
    import pkg from "./package.json";
    import {
      defaultExternals,
      defaultOutputConfig,
      defaultPlugins,
      defaultProdPlugins,
      defaultServePlugins,
      isLibrary,
      isProd,
      isServe
    } from "@appnest/web-config";
    
    const folders = {
      dist: resolve(__dirname, "dist"),
      src: resolve(__dirname, "src/demo"),
      src_assets: resolve(__dirname, "src/demo/assets"),
      dist_assets: resolve(__dirname, "dist/assets")
    };
    
    const files = {
      main: join(folders.src, "main.ts"),
      src_index: join(folders.src, "index.html"),
      dist_index: join(folders.dist, "index.html")
    };
    
    export default {
      input: {
        main: files.main
      },
      output: [
        defaultOutputConfig({
          dir: folders.dist,
          format: "esm"
        })
      ],
      plugins: [
        ...defaultPlugins({
          copyConfig: {
            resources: [[folders.src_assets, folders.dist_assets]],
          },
          cleanerConfig: {
            targets: [
              folders.dist
            ]
          },
          htmlTemplateConfig: {
            template: files.src_index,
            target: files.dist_index,
            include: /main(-.*)?\.js$/
          },
          importStylesConfig: {
            globals: ["main.scss"]
          }
        }),
    
        // Serve
        ...(isServe ? [
            ...defaultServePlugins({
                dist: folders.dist
            })
        ] : []),
    
        // Production
        ...(isProd ? [
            ...defaultProdPlugins({
                dist: folders.dist
            })
        ] : [])
      ],
      treeshake: isProd,
      context: "window"
    }

    -----------------------------------------------------

    ➤ Step 3 - Setup .eslintrc.json

    {
      "extends": "./node_modules/@appnest/web-config/eslint.js"
    }

    -----------------------------------------------------

    ➤ Step 4 - Setup tsconfig.json

    {
      "extends": "./node_modules/@appnest/web-config/tsconfig.json"
    }

    -----------------------------------------------------

    ➤ Step 5 - Setup .browserslistrc

    The tools transpiling your code are using browserslist to figure out what is supported. Your .browserslistrc could look like this.

    last 2 Chrome versions
    last 2 Safari versions
    last 2 Firefox versions
    

    -----------------------------------------------------

    ➤ Step 6 - Setup karma.conf.js

    const {defaultResolvePlugins, defaultKarmaConfig} = require("@appnest/web-config");
    
    module.exports = (config) => {
      config.set({
        ...defaultKarmaConfig({
          rollupPlugins: defaultResolvePlugins()
        }),
        basePath: "src",
        logLevel: config.LOG_INFO
      });
    };

    -----------------------------------------------------

    ➤ Step 7 - Add start and build scripts to package.json

    Here an example on what scripts you could add to your package.json file.

    {
      ...
      scripts: {
        "b:dev": "rollup -c --environment NODE_ENV:dev",
        "b:prod": "rollup -c --environment NODE_ENV:prod",
        "s:dev": "rollup -c --watch --environment NODE_ENV:dev",
        "s:prod": "rollup -c --watch --environment NODE_ENV:prod",
        "s": "npm run s:dev"
        ...
      }
      ...
    }
    

    -----------------------------------------------------

    ➤ Step 8 - Setup prettier.config.js

    module.exports = {
       ...require("../node_modules/@appnest/web-config/rettier.config.js")
    };

    -----------------------------------------------------

    ➤ How to load stylesheets

    Add the following to your typings.d.ts file!

    This is to make Typescript not complaining about SCSS, CSS and JSON imports.

    /// <reference path="node_modules/@appnest/web-config/typings.d.ts" />

    Load a global stylesheet (it will be added to the template file)

    Step 1: Import your stylesheet using the ES6 import syntax

    import "./main.scss";

    Step 2: Include the name of the stylesheet in your Rollup config

    export default {
      ...
        defaultPlugins({
           ...
           importStylesConfig: {
             globals: ["main.scss"]
           },
           ...
        }),
      ...
    }

    Load a stylesheet as a string

    import css from "./my-component.scss";

    -----------------------------------------------------

    ➤ Contributors

    Andreas Mehlsen You?
    Andreas Mehlsen You?

    -----------------------------------------------------

    ➤ License

    Licensed under MIT.

    Install

    npm i @appnest/web-config

    DownloadsWeekly Downloads

    166

    Version

    0.5.4

    License

    MIT

    Unpacked Size

    278 kB

    Total Files

    16

    Last publish

    Collaborators

    • explore
    • runebm