refactor(types): enhance type system (#1299)

* refactor(type): use Record for json constant

* refactor(type): use Record for json constant

* chore(eslint): clean up import type error

* chore(type): extract third lib to spec

Author: mydearxym

.eslintrc.js

@@ -8,6 +8,8 @@ module.exports = {
     '@groupher/eslint-config-web',
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
+    // see: https://stackoverflow.com/a/56696478/4050784
+    'plugin:import/typescript',
   ],
   // extends: ['@groupher/eslint-config-web'],
   settings: {

package-lock.json

@@ -161,6 +161,7 @@
     "shelljs": "0.8.4",
     "standard-version": "^8.0.1",
     "start-server-and-test": "1.12.1",
+    "type-fest": "^2.12.2",
     "typescript": "^4.2.3"
   }
 }

package.json

@@ -210,6 +210,7 @@ export type TUpvoteLayout =
   | 'comment'
   | 'article'
   | 'post-list'
+  | 'blog-list'
   | 'works-article'
   | 'works-card'
   | 'guide-list'

src/spec/article.ts

@@ -0,0 +1,3 @@
+// see: https://github.com/sindresorhus/type-fest#template-literal-types
+export type { ScreamingSnakeCase as SnakeUpperCase } from 'type-fest'
+export type holder = 1

src/spec/enhance.ts

@@ -1,7 +1,10 @@
 import type { TRootStore as RootStoreType } from '@/stores/RootStore'
+
 import type { TArticle } from './article'
 import type { TCommunity } from './community'
 
+export type { SnakeUpperCase } from './enhance'
+
 export type { TMetric } from './metric'
 export type {
   TSIZE,

src/spec/index.ts

@@ -96,7 +96,11 @@ export type TTabItem = {
 
 export type TResState = 'LOADING' | 'DONE' | 'EMPTY'
 
-export type TPaymentUsage = 'SENIOR' | 'GirlsCodeTooPlan' | 'DONATE' | 'SPONSOR'
+export type TPaymentUsage =
+  | 'SENIOR'
+  | 'GIRLS_CODE_TOO_PLAN'
+  | 'DONATE'
+  | 'SPONSOR'
 export type TPaymentMethod = 'ALIPAY' | 'WECHAT'
 
 export type TFlexRule =
@@ -183,7 +187,7 @@ export type TModelineType =
   | 'search'
   | 'more'
 
-export type TGtdType = 'BUG' | 'FEATURE' | null
-export type TGtdState = 'TODO' | 'WIP' | 'DONE' | null
+export type TGtdType = 'BUG' | 'FEATURE' | 'DEFAULT'
+export type TGtdState = 'TODO' | 'WIP' | 'DONE' | 'DEFAULT'
 
 export type TTagMode = 'default' | 'label'

src/spec/utils.ts

@@ -1,14 +1,14 @@
 import type { TGtdType, TGtdState } from '@/spec'
 
 export const GTD_TYPE = {
-  FEATURE: 'FEATURE' as TGtdType,
-  BUG: 'BUG' as TGtdType,
-  DEFAULT: null as TGtdType,
-}
+  FEATURE: 'FEATURE',
+  BUG: 'BUG',
+  DEFAULT: 'DEFAULT',
+} as Record<Uppercase<TGtdType>, Uppercase<TGtdType>>
 
 export const GTD_STATE = {
-  TODO: 'TODO' as TGtdState,
-  WIP: 'WIP' as TGtdState,
-  DONE: 'DONE' as TGtdState,
-  DEFAULT: null as TGtdState,
-}
+  TODO: 'TODO',
+  WIP: 'WIP',
+  DONE: 'DONE',
+  DEFAULT: 'DEFAULT',
+} as Record<Uppercase<TGtdState>, Uppercase<TGtdState>>

utils/constant/GTD.ts

@@ -1,12 +1,12 @@
 import type { TEmotionType } from '@/spec'
 
 const EMOTION = {
-  DOWNVOTE: 'downvote' as TEmotionType,
-  BEER: 'beer' as TEmotionType,
-  HEART: 'heart' as TEmotionType,
-  CONFUSED: 'confused' as TEmotionType,
-  POPCORN: 'popcorn' as TEmotionType,
-  PILL: 'pill' as TEmotionType,
-}
+  DOWNVOTE: 'downvote',
+  BEER: 'beer',
+  HEART: 'heart',
+  CONFUSED: 'confused',
+  POPCORN: 'popcorn',
+  PILL: 'pill',
+} as Record<Uppercase<TEmotionType>, TEmotionType>
 
 export default EMOTION

utils/constant/emotion.ts

@@ -1,14 +1,14 @@
-import type { TUpvoteLayout } from '@/spec'
+import type { TUpvoteLayout, SnakeUpperCase } from '@/spec'
 
 export const UPVOTE_LAYOUT = {
-  DEFAULT: 'default' as TUpvoteLayout,
-  COMMENT: 'comment' as TUpvoteLayout,
-  ARTICLE: 'article' as TUpvoteLayout,
-  POST_LIST: 'post-list' as TUpvoteLayout,
-  BLOG_LIST: 'blog-list' as TUpvoteLayout,
-  WORKS_ARTICLE: 'works-article' as TUpvoteLayout,
-  WORKS_CARD: 'works-card' as TUpvoteLayout,
-  GUIDE_LIST: 'guide-list' as TUpvoteLayout,
-}
+  DEFAULT: 'default',
+  COMMENT: 'comment',
+  ARTICLE: 'article',
+  POST_LIST: 'post-list',
+  BLOG_LIST: 'blog-list',
+  WORKS_ARTICLE: 'works-article',
+  WORKS_CARD: 'works-card',
+  GUIDE_LIST: 'guide-list',
+} as Record<SnakeUpperCase<TUpvoteLayout>, TUpvoteLayout>
 
 export const holder = 1