Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example for preset-typescript with vue-cli and potential fix #122

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions examples/ts-vue-cli/.storybook/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
stories: ['../src/**/*.stories.(ts|mdx)'],
addons: [
{
name: '@storybook/preset-typescript',
options: {
forkTsCheckerWebpackPluginOptions: {
colors: false, // disables built-in colors in logger messages
},
},
},
],
};
3 changes: 3 additions & 0 deletions examples/ts-vue-cli/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: ['@vue/cli-plugin-babel/preset'],
};
28 changes: 28 additions & 0 deletions examples/ts-vue-cli/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "example-ts-vue-cli",
"version": "0.1.0",
"private": true,
"scripts": {
"build": "exit 0;",
"storybook": "start-storybook -p 6006",
"build-storybook": "build-storybook",
"serve": "vue-cli-service serve"
},
"dependencies": {
"@vue/cli-plugin-babel": "^4.2.3",
"@vue/cli-plugin-typescript": "~4.2.0",
"@vue/cli-service": "~4.2.0",
"vue-class-component": "^7.2.2",
"vue-property-decorator": "^8.3.0",
"@babel/core": "^7.8.7",
"@storybook/addon-docs": "^5.3.14",
"@storybook/preset-typescript": "*",
"@storybook/vue": "^5.3.14",
"babel-loader": "^8.0.6",
"babel-preset-vue": "^2.0.2",
"typescript": "^3.8.3",
"vue": "^2.6.11",
"vue-loader": "^15.9.0",
"vue-template-compiler": "^2.6.11"
}
}
16 changes: 16 additions & 0 deletions examples/ts-vue-cli/src/App.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<template>
<div id="app">
<Button>Hello</Button>
</div>
</template>

<script lang="ts">
import { Component, Vue } from 'vue-property-decorator';
import Button from './components/Button/Button.vue';
@Component({
components: {
Button,
},
})
export default class App extends Vue {}
</script>
9 changes: 9 additions & 0 deletions examples/ts-vue-cli/src/components/Button/Button.stories.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import Button from './Button.vue';

// eslint-disable-next-line import/no-default-export
export default { title: 'Button', component: Button };

export const Default = (): object => ({
components: { Button },
template: '<Button>Example</Button>',
});
21 changes: 21 additions & 0 deletions examples/ts-vue-cli/src/components/Button/Button.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<template>
<div class="button-class">{{label}}</div>
</template>

<script lang="ts">
import { Component, Prop, Vue } from 'vue-property-decorator';

@Component
export default class ButtonClass extends Vue {
@Prop({ type: String, default: 'Label'}) private label!: string;
}
</script>

<style>
.button-class {
display: inline-block;
border: 1px solid #aaa;
background-color: #fff;
border-radius: 3px;
}
</style>
9 changes: 9 additions & 0 deletions examples/ts-vue-cli/src/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import Vue from 'vue';
import App from './App.vue';

Vue.config.productionTip = false;

new Vue({
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
render: h => h(App),
}).$mount('#app');
6 changes: 6 additions & 0 deletions examples/ts-vue-cli/src/shims-vue.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
declare module '*.vue' {
import Vue from 'vue';

// eslint-disable-next-line import/no-default-export
export default Vue;
}
14 changes: 14 additions & 0 deletions examples/ts-vue-cli/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"skipLibCheck": true,
"esModuleInterop": true,
"experimentalDecorators": true,
"strict": true,
"module": "esnext",
"moduleResolution": "node",
"noEmit": true
},
"include": ["src", ".storybook/*"]
}
3 changes: 2 additions & 1 deletion packages/preset-typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"@storybook/node-logger": "^5.3.17",
"@types/babel__core": "^7.1.6",
"babel-preset-typescript-vue": "^1.0.3",
"fork-ts-checker-webpack-plugin": "^4.1.0"
"fork-ts-checker-webpack-plugin": "^4.1.0",
"ts-loader": "^6.2.2"
},
"devDependencies": {
"typescript": "^3.8.3"
Expand Down
33 changes: 31 additions & 2 deletions packages/preset-typescript/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Configuration } from 'webpack'; // eslint-disable-line import/no-extraneous-dependencies
import { Configuration, Module, RuleSetRule } from 'webpack'; // eslint-disable-line import/no-extraneous-dependencies
import { Options } from './options';
import { processConfig } from './helpers/processConfig';
import { isCompatible } from './helpers/isCompatible';
Expand Down Expand Up @@ -63,7 +63,36 @@ export const webpack = (
vue: options.forkTsCheckerWebpackPluginOptions?.vue ?? true,
},
};
return processConfig(webpackConfig, updatedOptions);

const { tsLoaderOptions = { transpileOnly: true } } = options;
tsLoaderOptions.appendTsSuffixTo = [
...(tsLoaderOptions.appendTsSuffixTo || []),
/\.vue$/,
];

const tsLoader: RuleSetRule = {
test: /\.tsx?$/,
use: [
{
loader: require.resolve('ts-loader'),
options: tsLoaderOptions,
},
],
};

if (options.include) {
tsLoader.include = options.include;
}

const module: Module = webpackConfig.module || { rules: [] };
const updatedWebpack = {
...webpackConfig,
module: {
...module,
rules: [...module.rules, tsLoader],
},
};
return processConfig(updatedWebpack, updatedOptions);
}

return processConfig(webpackConfig, options);
Expand Down
3 changes: 3 additions & 0 deletions packages/preset-typescript/src/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,7 @@ export interface Options {
presets: PluginItem[] | null;
};
framework: 'angular' | 'react' | 'vue'; // NOTE: Non-exhaustive list.

// TODO: Proper typing
tsLoaderOptions: any;
}
Loading