chore: supplementary type (umijs#3193)

nannanli · Sep 12, 2019 · 57ebd18 · 57ebd18
1 parent 3af0fac
commit 57ebd18
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 12 deletions.
diff --git a/packages/umi-utils/src/chunkName.ts b/packages/umi-utils/src/chunkName.ts
@@ -1,6 +1,6 @@
 import winPath from './winPath';
 
-function stripFirstSlash(path: string) {
+function stripFirstSlash(path: string): string {
   if (path.charAt(0) === '/') {
     return path.slice(1);
   } else {
@@ -13,7 +13,7 @@ function stripFirstSlash(path: string) {
  * @param cwd
  * @param path
  */
-export default function chunkName(cwd: string, path: string) {
+export default function chunkName(cwd: string, path: string): string {
   return stripFirstSlash(winPath(path).replace(winPath(cwd), ''))
     .replace(/\//g, '__')
     .replace(/^src__/, '')

diff --git a/packages/umi-utils/src/compatDirname.ts b/packages/umi-utils/src/compatDirname.ts
@@ -8,7 +8,7 @@ import winPath from './winPath';
  * @param cwd process cwd
  * @param fallback
  */
-export default function(path: string, cwd: string, fallback?: any) {
+export default function(path: string, cwd: string, fallback?: any): any {
   const pkg = findPkg(path, cwd);
   if (pkg) return pkg;
 
@@ -25,7 +25,7 @@ export default function(path: string, cwd: string, fallback?: any) {
  * @param path module name
  * @param cwd
  */
-function findPkg(path: string, cwd: string) {
+function findPkg(path: string, cwd: string): string {
   const pkgPath = join(cwd, 'package.json');
   const library = path.split('/')[0];
   if (existsSync(pkgPath)) {

diff --git a/packages/umi-utils/src/deprecate.ts b/packages/umi-utils/src/deprecate.ts
@@ -8,7 +8,7 @@ const hits = new Set<string>();
  * @param methodName
  * @param args
  */
-export default function deprecate(methodName: string, ...args) {
+export default function deprecate(methodName: string, ...args): void {
   if (hits[methodName]) return;
   hits[methodName] = true;
   const stream = process.stderr;

diff --git a/packages/umi-utils/src/endWithSlash.ts b/packages/umi-utils/src/endWithSlash.ts
@@ -2,6 +2,6 @@
  * Make up the ending slash path （ /abc => /abc/ ）
  * @param path string
  */
-export default function endWithSlash(path: string) {
+export default function endWithSlash(path: string): string {
   return path.slice(-1) !== '/' ? `${path}/` : path;
 }
diff --git a/packages/umi-utils/src/findCSS.ts b/packages/umi-utils/src/findCSS.ts
@@ -8,7 +8,7 @@ const CSS_EXTNAMES = ['.css', '.less', '.scss', '.sass'];
  * @param {*} baseDir
  * @param {*} fileNameWithoutExtname
  */
-export default function(baseDir: string, fileNameWithoutExtname: string) {
+export default function(baseDir: string, fileNameWithoutExtname: string): string {
   let i = 0;
   while (i < CSS_EXTNAMES.length) {
     const extname = CSS_EXTNAMES[i];

diff --git a/packages/umi-utils/src/findJS.ts b/packages/umi-utils/src/findJS.ts
@@ -8,7 +8,7 @@ const JS_EXTNAMES = ['.js', '.jsx', '.ts', '.tsx'];
  * @param baseDir base path
  * @param fileNameWithoutExtname file name
  */
-export default function(baseDir: string, fileNameWithoutExtname: string) {
+export default function(baseDir: string, fileNameWithoutExtname: string): string {
   let i = 0;
   while (i < JS_EXTNAMES.length) {
     const extname = JS_EXTNAMES[i];

diff --git a/packages/umi-utils/src/isUrl.ts b/packages/umi-utils/src/isUrl.ts
@@ -4,6 +4,6 @@ import isUrl from 'is-url';
  * Check whether a string is a URL.
  * @param path
  */
-export default function(path: string) {
+export default function(path: string): boolean {
   return isUrl(path);
 }
diff --git a/packages/umi-utils/src/prettierFile.ts b/packages/umi-utils/src/prettierFile.ts
@@ -1,11 +1,28 @@
 import * as prettier from 'prettier';
 
+type PrettierFormatParser =
+  | 'babel'
+  | 'babel-flow'
+  | 'flow'
+  | 'typescript'
+  | 'css'
+  | 'scss'
+  | 'less'
+  | 'json'
+  | 'json5'
+  | 'json-stringify'
+  | 'graphql'
+  | 'markdown'
+  | 'mdx'
+  | 'html'
+  | 'lwc'
+  | 'yaml';
 /**
  * prettier code
  * @param fileContent file flow string
  * @param parser default typescript
  */
-export default function(fileContent: string, parser: string = 'typescript') {
+export default function(fileContent: string, parser: PrettierFormatParser = 'typescript'): string {
   try {
     return prettier.format(fileContent, {
       parser,

diff --git a/packages/umi-utils/src/winEOL.ts b/packages/umi-utils/src/winEOL.ts
@@ -8,7 +8,7 @@ const isWindows = typeof process !== 'undefined' && process.platform === 'win32'
  * Convert Windows crlf to lf (\r\n to \n)
  * @param content
  */
-export default (content: any) => {
+export default (content: string | undefined) => {
   if (typeof content !== 'string') {
     return content;
   }

diff --git a/packages/umi-utils/src/winPath.ts b/packages/umi-utils/src/winPath.ts
@@ -4,6 +4,6 @@ import slash from 'slash2';
  * Convert Windows backslash paths to slash paths
  * @param path
  */
-export default function(path: string) {
+export default function(path: string): string {
   return slash(path);
 }