initial commit

Author: pi0

.eslintignore

@@ -0,0 +1 @@
+dist

.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@nuxtjs/eslint-config-typescript"
+  ]
+}

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [12, 14]
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: checkout
+        uses: actions/checkout@master
+
+      - name: cache node_modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
+
+      - name: Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: yarn
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn jest
+
+      - name: Coverage
+        uses: codecov/codecov-action@v1

.gitignore

@@ -0,0 +1,7 @@
+.vscode
+node_modules
+*.log
+.DS_Store
+coverage
+dist
+types

README.md

@@ -0,0 +1,65 @@
+# `@nuxt/theme`
+
+Magically theme/extends support to Nuxt 2 projects!
+
+## Features
+
+- Forward compatible with nuxt3 multi app
+- Support neseted `extends`
+- Smartly merge config and hooks
+- Allow theme development to be like a normal nuxt project
+
+## Usage
+
+### Common Setup
+
+Install `@nuxt/theme` as a dependency:
+
+```sh
+# yarn
+yarn add @nuxt/theme
+
+# npm
+npm i @nuxt/theme
+```
+
+Update `nuxt.config` file:
+
+```js
+import { resolveConfig } from '@nuxt/theme'
+
+export default resolveConfig({
+})
+```
+
+### Theme Consumer
+
+Use `extends` key in `nuxt.config`:
+
+```js
+import { resolveConfig } from '@nuxt/theme'
+
+export default resolveConfig({
+  extends: '@nuxt/docs-theme'
+})
+```
+
+**Note:** While it is not necessary, it is recommended to also follow [Theme Author](#theme-author) section for your project so it is reusable for others.
+
+### Theme Author
+
+- Update `nuxt.config` and ensure required `rootDir` and `name` properties are provided
+
+```js
+import { resolveConfig } from '@nuxt/theme'
+
+export default resolveConfig({
+  name: 'myTheme'
+  rootDir: __direname
+}
+
+- Instead of using `~/` or `@/` aliases, use `~myTheme` or `@myTheme`
+
+## License
+
+MIT

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  collectCoverage: true,
+  testEnvironment: 'node'
+}

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@nuxt/theme",
+  "version": "0.0.0",
+  "description": "",
+  "repository": "nuxt/theme",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "siroc build",
+    "lint": "eslint --ext .ts src",
+    "prepublish": "yarn build",
+    "release": "yarn test && yarn build && standard-version && git push --follow-tags && npm publish",
+    "test": "yarn lint && yarn jest"
+  },
+  "dependencies": {
+    "defu": "^3.2.0",
+    "hookable": "^4.3.1",
+    "jiti": "^0.1.12"
+  },
+  "devDependencies": {
+    "@nuxt/types": "^2.14.7",
+    "@nuxtjs/eslint-config-typescript": "latest",
+    "@types/jest": "latest",
+    "@types/node": "latest",
+    "eslint": "latest",
+    "jest": "latest",
+    "siroc": "^0.4.0",
+    "standard-version": "latest",
+    "ts-jest": "latest",
+    "typescript": "latest"
+  }
+}

src/index.ts

@@ -0,0 +1,75 @@
+import { dirname } from 'path'
+import Hookable, { configHooksT } from 'hookable'
+import defu from 'defu'
+import { NuxtConfig } from '@nuxt/types'
+
+declare module '@nuxt/types' {
+  interface NuxtConfig {
+    hooks: configHooksT
+    name?: string
+    extends?: string
+    alias?: { [key: string]: string }
+  }
+}
+
+export function extendConfig (base: NuxtConfig | string, target: NuxtConfig): NuxtConfig {
+  // Resolve Configs
+  base = resolveConfig(base)
+  target = resolveConfig(target)
+
+  // Ensure base has require fileds
+  if (!base.name) {
+    throw new Error('Base config is missing `name` property')
+  }
+  if (!base.rootDir) {
+    throw new Error('Base config is missing `rootDir` property')
+  }
+  if (!base.srcDir) {
+    base.srcDir = base.rootDir
+  }
+
+  // Ensure there is no name conflict
+  if (target.alias && target.alias['~' + base.name]) {
+    throw new Error('Theme name conflict: ' + base.name)
+  }
+
+  // Assign aliases for base
+  base.alias = base.alias || {}
+  base.alias['~' + base.name] = base.srcDir
+  base.alias['~~' + base.name] = base.rootDir
+  base.alias['@' + base.name] = base.srcDir
+  base.alias['@@' + base.name] = base.rootDir
+
+  // Custom merges
+  const override = {
+    hooks: Hookable.mergeHooks(base.hooks || {}, target.hooks || {})
+  }
+
+  // Merge with defu
+  return defu(override, target, base)
+}
+
+export function resolveConfig (config: string | NuxtConfig): NuxtConfig {
+  if (typeof config === 'string') {
+    const jiti = require('jiti')()
+
+    const name = config
+    const nuxtConfigFile = jiti.resolve(config)
+
+    config = jiti(nuxtConfigFile) as NuxtConfig
+
+    if (!config.rootDir) {
+      config.rootDir = dirname(nuxtConfigFile)
+    }
+
+    if (!config.name) {
+      config.name = name
+    }
+  }
+
+  if (config.extends) {
+    config = extendConfig(config.extends, config)
+  }
+
+  return config
+}

test/index.test.ts

@@ -0,0 +1,3 @@
+it('pass', () => {
+
+})

tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ES6",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "declaration": true
+  },
+  "include": [
+    "src"
+  ]
+}