Vue 工程的类型检查需求,一直是一个大问题。
For Vue projects, the requirement of type checking has been a big problem so far.
现在我们可以像这样使用 TypeScript 和 class 类解决这一问题,且无需任何构建期不透明的额外编译魔法,只需继承来自 j-vue
的 Component
:
Now we can use TypeScript and class like this to resolve this problem, without any extra opaque compilation magic at build time, you just need to extend Component
of j-vue
:
import { Component, mixin } from 'j-vue';
abstract class Mixin0 extends Component<Mixin0> {
#d = 0;
m0 () { return ++this.#d; }
}
const Mixin1 = {
methods: {
m1 () :void {}
}
};
interface Mixin1 extends Component<Mixin1> {
m1 () :void
}
const Mixins = mixin<Mixin0 & Mixin1>(Mixin0, Mixin1);
abstract class SuperComponent<Sub extends Component<Sub>> extends Mixins<Sub> {
s () :void {}
}
abstract class SubComponent extends SuperComponent<SubComponent> {
/* methods */
m () { ++this.d; }
/* computed */
get c () { return this.d; }
set c (value) { this.d = value; }
/* hooks (Non-static for type, starts with `_` wouldn't waste any name) */
// No conflict to methods and so on
_created () { this.c; }
/* watch (Non-static for type, starts with `_watch(`) */
// watch exp (key) & handler (value)
'_watch(d)' (d :this['d'], old_d :this['d']) { }
// watch exp (key) & handler (value) (with options)
'_watch(d);deep;immediate;flush=pre' (d :this['d'], old_d? :this['d']) { }
// watch fn (getter) & handler (setter), better for auto type
get '_watch(placeholder)' () { return this.d; }
set '_watch(placeholder)' (d) { }
// watch fn (getter) & handler (setter) (another)
get '_watch(placeholder2--can be any unique words in fact);immediate' () { return this.#r.value; }
set '_watch(placeholder2--can be any unique words in fact);immediate' (r) { }
/* emits (Non-static for type, also starts with `_`) */
get _emits () {
return {
e1: (value :unknown) :value is 1 => value===1,
e2: (arg0 :0, arg1 :1) :boolean => arg0===0 && arg1===1,
};
}
// For current TypeScript, `this :SubComponent` is necessary in method including `$emit` calling!
e (this :SubComponent) {
this.$emit('e1', 1).$emit('e2', 0, 1);
}
/* props (like emits) */
get _props () { return [ 'p' ] as const; }
declare readonly p? :string;
/* inject (Like props) */
get _inject () { return [ 'i' ] as const; }
declare readonly i :boolean;
/* data */
d :number = 0;
// Mark it `protected` or `private`, to prevent access outside
protected D :number = 0;
// Hard private field can also be used! Though not reative directly (Which can also be intended)
#p :number = 0;
readonly #r :{ value :number } = Vue3.ref(0);
readonly #c :{ readonly value :number } = Vue3.computed(() => this.#r.value);
protected constructor (Vue3? :any) {// Really run once like options.data()! With real this!
super();
this.p;
this.i;
this.m;
this.d;
//this.c;// No computed, because constructor run inside options.data() (Compiled by jVue)
this.#p;
this.#r.value;
this.#c.value;
// It's possible to set instance level render like options.setup() returns in Vue 3:
Component.render = () => Vue3!.h('p', [ this.d ]);
}
_render () {
return arguments.length>1
? Vue3.h('p', [ this.d ])
: this.$createElement!('p', [ this.d ]);
}
/* Other options, like multiple ways to write render */
static render = function render (this :MyComponent) {
return arguments.length>1
? Vue3.h('p', [ this.d ])
: this.$createElement!('p', [ this.d ]);
};
static staticRenderFns = [];
static Render = class {
constructor (Vue3 :any) {
return function render (this :MyComponent) {
return Vue3.h('p', [ this.d ]);
};
}
} as any;
static template = `<p>{{ d }}</p>`;
static inheritAttrs = true;
static components = {};
static provide = {};
};
const vm3 :SubComponent = Vue3.createApp(SubComponent._toOptions(Vue3)) . mount('body ');
const vm2 :SubComponent = new ( Vue2.extend (SubComponent._toOptions( )) )().$mount('body > *');
import * as Vue3 from 'vue@3';
import Vue2 from '[email protected]';
前端组件的 CSS 局部作用域需求,一直是一个大问题。
For front-end components, the requirement of scoped CSS has been a big problem so far.
现在我们可以像这样使用 j-vue
模块来解决这一问题:
Now we can use j-vue
like this to resolve this problem:
import { Scope, Style, Template } from 'j-vue';
const componentSharedStaticScope = Scope();
Style(`
.__static__ {
border: 1px solid black;
animation: __xxx__;
}
@keyframes __xxx__ { }
`, componentSharedStaticScope);
new Vue({
template: Template(`
<div class="__static__">
<STYLE>
.{{ instancePrivateDynamicScope( 'dynamic') }} { color: red; }
</STYLE>
<p :class="{ [instancePrivateDynamicScope( 'dynamic')]: red }">text</p>
<p :class=" instancePrivateDynamicScope({ dynamic : red })">text (object)</p>
<p :class=" instancePrivateDynamicScope([ red && 'dynamic' ])">text (array)</p>
<p :class=" instancePrivateDynamicScope( red && 'dynamic' )">text (arguments)</p>
<button @click="change">change</button>
</div>
`, componentSharedStaticScope),
data: () => ( {
red: false,
instancePrivateDynamicScope: Scope(),
} ),
methods: {
change () { this.red = !this.red; },
},
});
这最终将执行为:
This will eventually be executed as:
document.head.appendChild(document.createElement('style')).textContent = `
.a {
border: 1px solid black;
animation: b;
}
@keyframes b { }
`;
new Vue({
template: `
<div class="a">
<STYLE> .c { color:red; } </STYLE>
<p :class="{ c: red }">text</p>
<p :class="{ c: red }">text (object)</p>
<p :class="[ red && 'c' ]">text (array)</p>
<p :class=" red && 'c' ">text (arguments)</p>
<button @click="change">change</button>
</div>
`,
data: () => ( {
red: false,
} ),
methods: {
change () { this.red = !this.red; },
/*instancePrivateDynamicScope:
j-vue 内置的 36 进制(0-9a-z)发号器,并会跳过所有数字打头的值,
且至少包含一个数字以避开各种保留字(这意味着第一个号会是“a0”)。
A base-36 (0-9a-z) ID generator build-in j-vue, and skip all value starts with digit,
and will include at least one digit to avoid reserved words (that means "a0" will be the first ID).
*/
},
});
从此,我们可以这样写 .vue
单文件组件:(只需要预处理器的支持 ①)
So, we can write our .vue
single-file component like this from now on: (only need pre-processor support ①)
<style>
.__static__ {
border: 1px solid black;
animation: __xxx__;
}
@keyframes __xxx__ { }
</style>
<template>
<div class="__static__">
<STYLE>
.{{ instancePrivateDynamicScope('dynamic') }} { color: red; }
</STYLE>
<p :class="{ [instancePrivateDynamicScope( 'dynamic')]: red }">text</p>
<p :class=" instancePrivateDynamicScope({ dynamic : red })">text (object)</p>
<p :class=" instancePrivateDynamicScope([ red && 'dynamic' ])">text (array)</p>
<p :class=" instancePrivateDynamicScope( red && 'dynamic' )">text (arguments)</p>
<button @click="change">change</button>
</div>
</template>
<script>
import { template, Scope } from '?j-vue';
new Vue({
template,
data: () => ( {
red: false,
instancePrivateDynamicScope: Scope(),
} ),
methods: {
change () { this.red = !this.red; },
},
});
</script>
这种运行时方案比静态编译选择器名的做法,一来更可靠(只有前端全局发号器才能真正保证类名绝对不重复 ②),二来可以达到以实例为单位的动态使用的目的。
This kind of runtime solution is more reliable (only front-end global id generator can promise unique selector ②) and support dynamically use.
① 刚刚提到的后端预处理器(用于单文件组件编译)也有提供:
① Back-end pre-processor we just mentioned (for single-file component compiling) is also supplied:
const { SFC } = require('j-vue');
const sfc = new SFC(source);
sfc.export('default');
// import { ... } from '?j-vue';
// export default { ... };
sfc.export('const');
// import * as jVue from 'j-vue';
// export const scopeFunction = jVue.Scope().$( ... );
// export const delimiters = [ '{{', '}}' ];
// export const template = jVue.Template( ... );
// export const Render = jVue.Render( ... );
// export const render = jVue.Render( ... );
// export const staticRenderFns = StaticRenderFns( ... );
// export { Identifier, Scope, Style, remove, Component, mixin, prop } from 'j-vue';
② 另一种足够可靠的方法是通过选择器后的全部样式内容,用可逆算法生成选择器名,这样即便同名内容也是完全一样的;不过出于多种考虑,j-vue
没有选用这种做法。
② Another reliable way is using reversible algorithm to generate the selector name by all the style content after the selector, so that if names conflict, their contents are also the same; but for reasons, j-vue
didn't choose this way.