chore: rename to @vue/composition-api

Author: liximomo

CHANGELOG.md

@@ -1,21 +1,3 @@
-# 3.0.0-beta.0
-
-`vue-function-api` v3.0.0 reflects the new [Composition API](https://vue-composition-api-rfc.netlify.com/) RFC. 
-The version is limited to beta until the RFC has been merged.
-
-## Changed
-* rename `value` to `ref`.
-* rename `state` to `reactive`.
-* remove `ref` from `SetupContext`.
-* export `plugin` as `default export`
-  ```js
-  import VueFunctionApi from 'vue-function-api';
-  Vue.use(VueFunctionApi);
-  ```
-
-## Added
-* new APIs `toRefs` and `isRef`.
-
 # 2.2.0
 * Improve typescript support.
 * Export `createElement`.
@@ -24,15 +6,15 @@ The version is limited to beta until the RFC has been merged.
 * Allow string keys in `provide`/`inject`.
 
 # 2.1.2
-* Remove auto-unwrapping for Array ([#53](https://github.com/vuejs/vue-function-api/issues/53)).
+* Remove auto-unwrapping for Array ([#53](https://github.com/vuejs/composition-api/issues/53)).
 
 # 2.1.1
-* Export `set` from `vue-function-api`. Using exported `set` whenever you need to use [Vue.set](https://vuejs.org/v2/api/#Vue-set) or [vm.$set](https://vuejs.org/v2/api/#vm-set). The custom `set` ensures that auto-unwrapping works for the new property.
+* Export `set()` function. Using exported `set` whenever you need to use [Vue.set](https://vuejs.org/v2/api/#Vue-set) or [vm.$set](https://vuejs.org/v2/api/#vm-set). The custom `set` ensures that auto-unwrapping works for the new property.
 * Add a new signature of `provide`: `provide(key, value)`.
 * Fix multiple `provide` invoking per component.
 * Fix order of `setup` invoking.
-* `onErrorCaptured` not triggered ([#25](https://github.com/vuejs/vue-function-api/issues/25)).
-* Fix `this` losing in nested setup call ([#38](https://github.com/vuejs/vue-function-api/issues/38)).
+* `onErrorCaptured` not triggered ([#25](https://github.com/vuejs/composition-api/issues/25)).
+* Fix `this` losing in nested setup call ([#38](https://github.com/vuejs/composition-api/issues/38)).
 * Fix some edge cases of unwarpping.
 * Change `context.slots`'s value. It now proxies to `$scopeSlots` instead of `$slots`.
 

README.md

@@ -2,7 +2,7 @@
 
 > [Vue Composition API](https://vue-composition-api-rfc.netlify.com/)
 
-`vue-function-api` provides a way to use Vue3's **Composition api** in `Vue2.x`.
+`@vue/composition-api` provides a way to use Vue3's **Composition api** in `Vue2.x`.
 
 [**中文文档**](./README.zh-CN.md)
 
@@ -15,39 +15,39 @@
 - [TypeScript](#TypeScript)
 - [Limitations](#Limitations)
 - [API](https://vue-composition-api-rfc.netlify.com/api.html)
-- [Changelog](https://github.com/vuejs/vue-function-api/blob/master/CHANGELOG.md)
+- [Changelog](https://github.com/vuejs/composition-api/blob/master/CHANGELOG.md)
 
 # Installation
 
 **npm**
 
 ```bash
-npm install vue-function-api --save
+npm install @vue/composition-api --save
 ```
 
 **yarn**
 
 ```bash
-yarn add vue-function-api
+yarn add @vue/composition-api
 ```
 
 **CDN**
 
 ```html
-<script src="https://unpkg.com/vue-function-api/dist/vue-function-api.umd.js"></script>
+<script src="https://unpkg.com/@vue/composition-api/dist/vue-composition-api.umd.js"></script>
 ```
 
-By using the global variable `window.vueFunctionApi`
+By using the global variable `window.vueCompositionApi`
 
 # Usage
 
-You must explicitly install `vue-function-api` via `Vue.use()`:
+You must install `@vue/composition-api` via `Vue.use()` before using other APIs:
 
 ```js
 import Vue from 'vue';
-import VueFunctionApi from 'vue-function-api';
+import VueCompositionApi from '@vue/composition-api';
 
-Vue.use(VueFunctionApi);
+Vue.use(VueCompositionApi);
 ```
 
 After installing the plugin you can use the [Composition API](https://vue-composition-api-rfc.netlify.com/) to compose your component.
@@ -57,7 +57,7 @@ After installing the plugin you can use the [Composition API](https://vue-compos
 To let TypeScript properly infer types inside Vue component options, you need to define components with `createComponent`:
 
 ```ts
-import { createComponent } from 'vue-function-api';
+import { createComponent } from '@vue/composition-api';
 
 const Component = createComponent({
   // type inference enabled
@@ -240,7 +240,7 @@ export default {
 
 If you really want to use template refs in this case, you can access `vm.$refs` via `SetupContext.refs`.
 
-> :warning: **Warning**: The `SetupContext.refs` won't existed in `Vue3.0`. `Vue-function-api` provide it as a workaround here.
+> :warning: **Warning**: The `SetupContext.refs` won't existed in `Vue3.0`. `@vue/composition-api` provide it as a workaround here.
 
 ```js
 export default {
@@ -266,11 +266,11 @@ You may also need to augment the `SetupContext` when wokring with TypeScript:
 
 ```ts
 import Vue from 'vue';
-import VueFunctionApi from 'vue-function-api';
+import VueCompositionApi from '@vue/composition-api';
 
-Vue.use(VueFunctionApi);
+Vue.use(VueCompositionApi);
 
-declare module 'vue-function-api/dist/component/component' {
+declare module '@vue/composition-api/dist/component/component' {
   interface SetupContext {
     readonly refs: { [key: string]: Vue | Element | Vue[] | Element[] };
   }

README.zh-CN.md

@@ -2,7 +2,7 @@
 
 > [Vue Composition API](https://vue-composition-api-rfc.netlify.com/)
 
-`vue-function-api` 使开发者们可以在 `Vue2.x` 中使用 `Vue3` 引入的**基于函数**的**逻辑复用机制**。
+`@vue/composition-api` 使开发者们可以在 `Vue2.x` 中使用 `Vue3` 引入的**基于函数**的**逻辑复用机制**。
 
 [**English Version**](./README.md)
 
@@ -15,39 +15,39 @@
 - [TypeScript](#TypeScript)
 - [限制](#限制)
 - [API](https://vue-composition-api-rfc.netlify.com/api.html)
-- [Changelog](https://github.com/vuejs/vue-function-api/blob/master/CHANGELOG.md)
+- [Changelog](https://github.com/vuejs/composition-api/blob/master/CHANGELOG.md)
 
 # 安装
 
 **npm**
 
 ```bash
-npm install vue-function-api --save
+npm install @vue/composition-api --save
 ```
 
 **yarn**
 
 ```bash
-yarn add vue-function-api
+yarn add @vue/composition-api
 ```
 
 **CDN**
 
 ```html
-<script src="https://unpkg.com/vue-function-api/dist/vue-function-api.umd.js"></script>
+<script src="https://unpkg.com/@vue/composition-api/dist/vue-composition-api.umd.js"></script>
 ```
 
-通过全局变量 `window.vueFunctionApi` 来使用。
+通过全局变量 `window.vueCompositionApi` 来使用。
 
 # 使用
 
-您必须显式地通过 `Vue.use()` 来安装 `vue-function-api`:
+在使用任何 `@vue/composition-api` 提供的能力前，必须先通过 `Vue.use()` 进行安装:
 
 ```js
 import Vue from 'vue';
-import VueFunctionApi from 'vue-function-api';
+import VueCompositionApi from '@vue/composition-api';
 
-Vue.use(VueFunctionApi);
+Vue.use(VueCompositionApi);
 ```
 
 安装插件后，您就可以使用新的[Composition API](https://vue-composition-api-rfc.netlify.com/)来开发组件了。
@@ -57,7 +57,7 @@ Vue.use(VueFunctionApi);
 为了让 TypeScript 正确的推到类型，我们必须使用 `createComponent` 来定义组件:
 
 ```ts
-import { createComponent } from 'vue-function-api';
+import { createComponent } from '@vue/composition-api';
 
 const Component = createComponent({
   // 启用类型推断
@@ -237,7 +237,7 @@ export default {
 
 如果你依然选择在 `setup()` 中写 `render` 函数，那么你可以使用 `SetupContext.refs` 来访问模板引用，它等价于 vue2 中的 `this.$refs`:
 
-> :warning: **警告**: `SetupContext.refs` 并不属于 `Vue3.0` 的一部分, `Vue-function-api` 将其曝光在 `SetupContext` 中只是临时提供的一种变通方案。
+> :warning: **警告**: `SetupContext.refs` 并不属于 `Vue3.0` 的一部分, `@vue/composition-api` 将其曝光在 `SetupContext` 中只是临时提供的一种变通方案。
 
 ```js
 export default {
@@ -263,11 +263,11 @@ export default {
 
 ```ts
 import Vue from 'vue';
-import VueFunctionApi from 'vue-function-api';
+import VueCompositionApi from '@vue/composition-api';
 
-Vue.use(VueFunctionApi);
+Vue.use(VueCompositionApi);
 
-declare module 'vue-function-api/dist/component/component' {
+declare module '@vue/composition-api/dist/component/component' {
   interface SetupContext {
     readonly refs: { [key: string]: Vue | Element | Vue[] | Element[] };
   }

package.json

@@ -1,14 +1,15 @@
 {
-  "name": "vue-function-api",
+  "name": "@vue/composition-api",
   "version": "3.0.0-beta.0",
   "description": "Provide logic composition capabilities for Vue.",
   "keywords": [
     "vue",
+    "composition-api",
     "function-api"
   ],
-  "main": "dist/vue-function-api.js",
-  "umd:main": "dist/vue-function-api.umd.js",
-  "module": "dist/vue-function-api.module.js",
+  "main": "dist/vue-composition-api.js",
+  "umd:main": "dist/vue-composition-api.umd.js",
+  "module": "dist/vue-composition-api.module.js",
   "typings": "dist/index.d.ts",
   "author": {
     "name": "liximomo",
@@ -26,9 +27,9 @@
     "release": "bash scripts/release.sh"
   },
   "bugs": {
-    "url": "https://github.com/vuejs/vue-function-api/issues"
+    "url": "https://github.com/vuejs/composition-api/issues"
   },
-  "homepage": "https://github.com/vuejs/vue-function-api#readme",
+  "homepage": "https://github.com/vuejs/composition-api#readme",
   "devDependencies": {
     "@types/jest": "^24.0.13",
     "@types/node": "^12.0.2",

rollup.config.js

@@ -7,27 +7,27 @@ import replace from 'rollup-plugin-replace';
 
 const builds = {
   'cjs-dev': {
-    outFile: 'vue-function-api.js',
+    outFile: 'vue-composition-api.js',
     format: 'cjs',
     mode: 'development',
   },
   'cjs-prod': {
-    outFile: 'vue-function-api.min.js',
+    outFile: 'vue-composition-api.min.js',
     format: 'cjs',
     mode: 'production',
   },
   'umd-dev': {
-    outFile: 'vue-function-api.umd.js',
+    outFile: 'vue-composition-api.umd.js',
     format: 'umd',
     mode: 'development',
   },
   'umd-prod': {
-    outFile: 'vue-function-api.umd.min.js',
+    outFile: 'vue-composition-api.umd.min.js',
     format: 'umd',
     mode: 'production',
   },
   es: {
-    outFile: 'vue-function-api.module.js',
+    outFile: 'vue-composition-api.module.js',
     format: 'es',
     mode: 'development',
   },
@@ -48,7 +48,7 @@ function genConfig({ outFile, format, mode }) {
         vue: 'Vue',
       },
       exports: 'named',
-      name: format === 'umd' ? 'vueFunctionApi' : undefined,
+      name: format === 'umd' ? 'vueCompositionApi' : undefined,
     },
     external: ['vue'],
     plugins: [

src/utils.ts

@@ -34,7 +34,7 @@ export function hasOwn(obj: Object | any[], key: string): boolean {
 }
 
 export function assert(condition: any, msg: string) {
-  if (!condition) throw new Error(`[vue-function-api] ${msg}`);
+  if (!condition) throw new Error(`[vue-composition-api] ${msg}`);
 }
 
 export function isArray<T>(x: unknown): x is T[] {