Skip to content

A simple workshop, guiding typescript in real project, implement interface type & fetch API native 🔥

Notifications You must be signed in to change notification settings

b0yblake/workshop01-ts-realworld

Repository files navigation

🐣 Pokémon dual with Vite 🌊

Screenshot

Performance

Getting Started 🚀

npm:

npm install
npm run dev
npm run build
npm run serve

Recommended ⚙

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can use the following:

If Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

If Using Vetur

  1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
  2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
  3. Open src/main.ts in VSCode
  4. Open the VSCode command palette
  5. Search and run "Select TypeScript version" -> "Use workspace version"

Command per-setup to force run ✔

  • npm install --save-dev @types/node for fix some types
  • npm install vite-plugin-components for auto-add global component (config in file vite)

New features of vite uses ✔

  • Please take a look closely to file vite.config.js, its contain some feature options good.
// Declare the path "@" instead of "/src"
alias: [{find: "@", replacement: path.resolve(__dirname, '/src')}
// Declare the path of variable source to use variable in style tag in components
css: {
  preprocessorOptions: {
    scss: {
      additionalData: `@import "./src/assets/stylesheets/_variables";` 
    } 
  } 
},
//