Skip to content

Latest commit

 

History

History
131 lines (94 loc) · 1.94 KB

README.md

File metadata and controls

131 lines (94 loc) · 1.94 KB

vite-layers

layers support for vite,quickly inherit your vite configuration


Motivation

I want to inherit the configuration of the vite project in workspace and npm package


Features

  1. inherit configuration file
    • npm package
    • relative position

Usage

install

npm i vite-layers -D

configuration

// vite.config.ts
import { Layers } from "vite-layers";

export default Layers({
  // Your own vite configuration now
  vite: {
    server: {
      port: 3000,
    },
  },
  extends: "../vite-vue", // The target directory you want to inherit
});

manual import

import Config from "../vite-vue/vite.config.ts"; // Manual Import Config
// vite.config.ts
import { Layers } from "vite-layers";

export default Layers({
  extends: Config, // The target directory you want to inherit
});

multiple

// vite.config.ts
import Config from "../vite-vue/vite.config.ts"; // Manual Import Config
import { Layers } from "vite-layers";

export default Layers({
  extends: [
    "../../vite-vue",
    Config,
  ], // Multiple target directories to inherit
});

normalize

// vite.config.ts
import { Layers } from "vite-layers";

export default Layers({
  normalize(config) {
    // Allows you to modify the final configuration
    return config;
  },
  extends: [
    "../../vite-vue",
  ],
});

npm package

// vite.config.ts
import { Layers } from "vite-layers";

export default Layers({
  extends: [
    "package", // your package
  ],
});

ts

If you are using TS and there is tsconfig.node.json, you need to add types

{
  "compilerOptions": {
    "types": ["vite"] // add vite
    // ...other content
  }
}

inspiration

Inspired by nuxt/layers


License

Made with markthree

Published under MIT License.