refactor: rename to nuxt-extend

Author: pi0

CHANGELOG.md

@@ -2,12 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [0.0.2](https://github.com/nuxt/theme/compare/v0.0.1...v0.0.2) (2020-11-18)
+### [0.0.2](https://github.com/nuxt-community/nuxt-extend/compare/v0.0.1...v0.0.2) (2020-11-18)
 
 ### 0.0.1 (2020-11-12)
 
 
 ### Features
 
-* components level ([41071f1](https://github.com/nuxt/theme/commit/41071f1ef8e9e627e0f40e5ddc32eecc596f691d))
-* improvements ([3d13c4f](https://github.com/nuxt/theme/commit/3d13c4f82ed5b92f438b82cf778706491b42e0ec))
+* components level ([41071f1](https://github.com/nuxt-community/nuxt-extend/commit/41071f1ef8e9e627e0f40e5ddc32eecc596f691d))
+* improvements ([3d13c4f](https://github.com/nuxt-community/nuxt-extend/commit/3d13c4f82ed5b92f438b82cf778706491b42e0ec))

README.md

@@ -1,14 +1,13 @@
-# `@nuxt/theme`
+# `nuxt-extend`
 
 [![npm version][npm-v-src]][npm-v-href]
 [![npm downloads][npm-d-src]][npm-d-href]
 [![ci][ci-src]][ci-href]
 
-Add theme/extends support to Nuxt 2 projects!
+Add config extending support to Nuxt 2 projects!
 
 ## Features
 
-- Forward compatible with Nuxt 3 multi Apps
 - Support nested `extends`
 - Smartly merge config and hooks
 - Allow theme development to be like a normal nuxt project
@@ -17,44 +16,44 @@ Add theme/extends support to Nuxt 2 projects!
 
 ### Common Setup
 
-Install `@nuxt/theme` as a dependency:
+Install `nuxt-extend` as a dependency:
 
 ```sh
 # yarn
-yarn add @nuxt/theme
+yarn add nuxt-extend
 
 # npm
-npm i @nuxt/theme
+npm i nuxt-extend
 ```
 
 Update `nuxt.config` file:
 
 ```js
-import { resolveConfig } from '@nuxt/theme'
+import { resolveConfig } from 'nuxt-extend'
 
 export default resolveConfig({
   // Your actual Nuxt configuration
 })
 ```
 
-### Theme Consumer
+### Parent
 
 Use `extends` key in `nuxt.config`:
 
 ```js
-import { resolveConfig } from '@nuxt/theme'
+import { resolveConfig } from 'nuxt-extend'
 
 export default resolveConfig({
   extends: '@nuxt/docs-theme',
 })
 ```
 
-### Theme Author
+### Child
 
 1. Update `nuxt.config` and ensure required `rootDir` and `name` properties are provided
 
 ```js
-import { resolveConfig } from '@nuxt/theme'
+import { resolveConfig } from 'nuxt-extend'
 
 export default resolveConfig({
   rootDir: __dirname,
@@ -71,11 +70,11 @@ export default resolveConfig({
 MIT. Made with 💖
 
 <!-- Refs -->
-[npm-v-src]: https://img.shields.io/npm/v/@nuxt/theme?style=flat-square
-[npm-v-href]: https://npmjs.com/package/@nuxt/theme
+[npm-v-src]: https://img.shields.io/npm/v/nuxt-extend?style=flat-square
+[npm-v-href]: https://npmjs.com/package/nuxt-extend
 
-[npm-d-src]: https://img.shields.io/npm/dm/@nuxt/theme?style=flat-square
-[npm-d-href]: https://npmjs.com/package/@nuxt/theme
+[npm-d-src]: https://img.shields.io/npm/dm/nuxt-extend?style=flat-square
+[npm-d-href]: https://npmjs.com/package/nuxt-extend
 
-[ci-src]: https://img.shields.io/github/workflow/status/nuxt/theme/ci/master?style=flat-square
-[ci-href]: https://github.com/nuxt/theme/actions?query=workflow%3Aci
+[ci-src]: https://img.shields.io/github/workflow/status/nuxt-community/nuxt-extend/ci/master?style=flat-square
+[ci-href]: https://github.com/nuxt-community/nuxt-extend/actions?query=workflow%3Aci

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "@nuxt/theme",
+  "name": "nuxt-extend",
   "version": "0.0.2",
   "description": "",
-  "repository": "nuxt/theme",
+  "repository": "nuxt-community/nuxt-extend",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,16 +23,16 @@
     "jiti": "^0.1.12"
   },
   "devDependencies": {
-    "@nuxt/components": "^1.1.1",
-    "@nuxt/types": "^2.14.7",
-    "@nuxt/typescript-runtime": "^2.0.0",
+    "@nuxt/components": "latest",
+    "@nuxt/types": "latest",
+    "@nuxt/typescript-runtime": "latest",
     "@nuxtjs/eslint-config-typescript": "latest",
     "@types/jest": "latest",
     "@types/node": "latest",
     "eslint": "latest",
     "jest": "latest",
-    "nuxt": "^2.14.7",
-    "siroc": "^0.4.1",
+    "nuxt": "latest",
+    "siroc": "latest",
     "standard-version": "latest",
     "ts-jest": "latest",
     "typescript": "latest"

src/index.ts

@@ -1,6 +1,7 @@
 import { dirname } from 'path'
 import Hookable, { configHooksT } from 'hookable'
 import defu from 'defu'
+import jiti from 'jiti'
 import type { NuxtConfig } from '@nuxt/types'
 
 declare module '@nuxt/types' {
@@ -15,9 +16,9 @@ declare module '@nuxt/types' {
 
 export function resolveConfig (config: string | NuxtConfig, from: string = process.cwd(), level = 0): NuxtConfig {
   if (typeof config === 'string') {
-    const jiti = require('jiti')(from)
-    const nuxtConfigFile = jiti.resolve(config)
-    config = jiti(nuxtConfigFile) as NuxtConfig
+    const _require = jiti(from)
+    const nuxtConfigFile = _require.resolve(config)
+    config = _require(nuxtConfigFile) as NuxtConfig
     config._file = nuxtConfigFile
 
     if (!config.rootDir) {
@@ -26,7 +27,7 @@ export function resolveConfig (config: string | NuxtConfig, from: string = proce
   }
 
   if (typeof config === 'function') {
-    throw new TypeError('@nuxt/theme does not support Nuxt config as function')
+    throw new TypeError('extending is not possible with nuxt config as a function')
   }
   if (!config.rootDir) {
     config.rootDir = from
@@ -48,18 +49,18 @@ export function resolveConfig (config: string | NuxtConfig, from: string = proce
 export function extendConfig (target: NuxtConfig, base: NuxtConfig): NuxtConfig {
   // Ensure base has required fields
   if (!base.name) {
-    throw new Error('Theme config is missing the `name` property' + (base._file ? `in ${base._file}` : ''))
+    throw new Error('Config is missing the `name` property' + (base._file ? `in ${base._file}` : ''))
   }
   if (!base.rootDir) {
-    throw new Error('Theme config is missing the `rootDir` property')
+    throw new Error('Config is missing the `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)
+    throw new Error('Name conflict: ' + base.name)
   }
 
   // Assign aliases for base

test/index.test.ts

@@ -24,7 +24,8 @@ const scrub = (input) => {
 
 it('fails on config being a function', () => {
   const config = () => ({})
-  expect(() => resolveConfig(config)).toThrow('@nuxt/theme does not support Nuxt config as function')
+  expect(() => resolveConfig(config))
+    .toThrow('extending is not possible with nuxt config as a function')
 })
 
 it('matches snapshot', () => {