[英]Exporting my own Flow type with npm package?
我有一個使用流進行類型檢查的 React 組件的 npm package。
對於我的組件的用戶來說,訪問我的流類型會很有用。 然而,目前我正在使用 Babel 編譯我的代碼,它會去除所有類型信息。
我的項目結構如下:
|
|- flowdecls
myTypes.js
| -components
- Component1
Component1.js
| - lib
- Component1.js (compiled using Babel)
- Component1.js.flow (created using flow-copy-source)
例如,我在myTypes.js
中的一種類型是
declare type DataItemIconType = {
iconElement: React$Element<React$ElementType>,
color?: string,
hoverColor?: string
}
我將在Component1
中使用。 例如Component1
的道具之一是
iconList : Array<DataItemIconType>
我已經發布了我的 React 組件庫的幾個版本作為 npm package 沒有 Flow 並且我的組件正在被廣泛使用。 但是我真的很想提供流量支持。
在我最近嘗試使用本文中指定的flow-copy-source (使用 Flow 創作和發布 JavaScript 模塊)但我的庫的用戶仍然無法訪問我的類型。
我如何讓在我的庫中使用Component1
的人可以使用DataItemIconType
之類的類型?
package.json
{
"name": "@company/react-common-components-build-template",
"version": "0.6.0",
"main": "./lib/index.js",
"private": true,
"engines": {
"node": ">=4.0.0"
},
"files": [
"lib"
],
"description": "Common component library",
"peerDependencies": {
"react": "16.10.0",
"react-dom": "16.10.0",
"prop-types": "15.7.2"
},
"dependencies": {
"@material-ui/core": "4.9.5",
"@material-ui/icons": "4.9.1",
"@material-ui/lab": "3.0.0-alpha.30",
"@material-ui/styles": "4.9.0",
"lodash": "4.17.15"
},
"devDependencies": {
"@babel/cli": "7.4.4",
"@babel/core": "7.6.0",
"@babel/node": "7.2.2",
"@babel/plugin-proposal-class-properties": "7.2.1",
"@babel/plugin-syntax-dynamic-import": "7.2.0",
"@babel/plugin-transform-object-assign": "7.2.0",
"@babel/plugin-transform-react-constant-elements": "7.6.0",
"@babel/plugin-transform-runtime": "7.6.2",
"@babel/preset-env": "7.4.2",
"@babel/preset-flow": "7.0.0",
"@babel/preset-react": "7.0.0",
"@babel/register": "7.0.0",
"@svgr/webpack": "4.3.2",
"@typescript-eslint/eslint-plugin": "^2.2.0",
"@typescript-eslint/parser": "^2.2.0",
"babel-eslint": "10.0.3",
"babel-jest": "24.9.0",
"babel-loader": "8.0.6",
"babel-plugin-named-asset-import": "0.3.4",
"babel-plugin-react-remove-properties": "0.3.0",
"babel-preset-react-app": "9.0.2",
"camelcase": "^5.2.0",
"case-sensitive-paths-webpack-plugin": "2.2.0",
"chokidar": "1.6.1",
"classnames": "2.2.6",
"cpx": "1.5.0",
"cross-env": "6.0.3",
"css-loader": "2.1.1",
"dotenv": "6.2.0",
"dotenv-expand": "5.1.0",
"enzyme": "3.10.0",
"enzyme-adapter-react-16": "1.15.1",
"enzyme-to-json": "3.4.3",
"eslint": "6.6.0",
"eslint-config-react-app": "5.0.2",
"eslint-loader": "3.0.0",
"eslint-plugin-flowtype": "3.13.0",
"eslint-plugin-flowtype-errors": "4.1.0",
"eslint-plugin-import": "2.18.2",
"eslint-plugin-jsx-a11y": "6.2.3",
"eslint-plugin-react": "7.16.0",
"eslint-plugin-react-hooks": "^2.3.0",
"file-loader": "3.0.1",
"flow-bin": "0.113.0",
"flow-copy-source": "^2.0.9",
"flow-typed": "^2.6.2",
"fs-extra": "7.0.1",
"glob-gitignore": "1.0.14",
"hard-source-webpack-plugin": "^0.13.1",
"highlight": "^0.2.4",
"highlight.js": "^9.10.0",
"html-webpack-plugin": "4.0.0-beta.5",
"husky": "3.0.8",
"identity-obj-proxy": "3.0.0",
"is-wsl": "^1.1.0",
"jest": "24.9.0",
"jest-environment-jsdom-fourteen": "1.0.1",
"jest-enzyme": "^7.1.2",
"jest-resolve": "24.9.0",
"jest-watch-typeahead": "0.4.0",
"mini-css-extract-plugin": "0.9.0",
"npm-run-all": "4.0.2",
"optimize-css-assets-webpack-plugin": "5.0.3",
"pnp-webpack-plugin": "1.5.0",
"postcss-flexbugs-fixes": "4.1.0",
"postcss-loader": "3.0.0",
"postcss-normalize": "7.0.1",
"postcss-preset-env": "6.7.0",
"postcss-safe-parser": "4.0.1",
"prettier": "1.19.1",
"react": "16.10.0",
"react-addons-test-utils": "15.5.1",
"react-app-polyfill": "^1.0.3",
"react-dev-utils": "10.2.0",
"react-docgen": "3.0.0",
"react-dom": "16.10.0",
"react-highlight": "^0.12.0",
"react-test-renderer": "16.10.0",
"resolve": "1.15.0",
"resolve-url-loader": "3.1.1",
"sass-loader": "8.0.2",
"semver": "6.3.0",
"style-loader": "1.0.0",
"terser-webpack-plugin": "2.3.4",
"ts-pnp": "1.1.5",
"url-loader": "2.3.0",
"webpack": "4.41.5",
"webpack-dev-server": "3.10.2",
"webpack-manifest-plugin": "2.2.0",
"workbox-webpack-plugin": "4.3.1"
},
"scripts": {
"prestart": "npm run gen:docs",
"start": "npm-run-all --parallel start:docs gen:docs-watch",
"start:docs": "node scripts/start.js",
"gen:docs": "node scripts/generateComponentData.js",
"gen:docs-watch": "npm run gen:docs -- --watch",
"build:docs": "node scripts/build.js",
"test": "node scripts/test.js",
"predeploy:docs": "npm run build:docs",
"flow": "flow",
"lint": "eslint src --debug",
"lint:flow-typed": "flow-typed install --ignoreDeps dev",
"build:images": "cpx \"./src/components/images/**/*.*\" ./lib/images",
"prebuild:common-components-lib": "rimraf lib",
"build:common-components-lib": "npm-run-all --parallel build:components build:utils build:images build:copy-files build:copyflowsource",
"build:components": "cross-env NODE_ENV=production BABEL_ENV=cjs babel ./src/components --out-dir ./lib/ --ignore spec.js",
"build:utils": "cross-env NODE_ENV=production BABEL_ENV=cjs babel src/components/utils --out-dir ./lib/utils --ignore spec.js",
"build:copyflowsource": "flow-copy-source ./src/components ./lib ",
"build:copy-files": "node scripts/copyBuildFiles.js",
"prettier:changed": "node ./scripts/prettier.js",
"prettier:all": "node ./scripts/prettier.js write",
"format-check": "prettier --check \"./src/**/*.{js,test.js,spec.js}\""
},
"publishConfig": {
"registry": "http://srv-ie-nexus/repository/npm-hosted/"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"jest": {
"roots": [
"<rootDir>/src/components"
],
"collectCoverageFrom": [
"src/**/*.{js,jsx,ts,tsx}",
"!src/**/*.d.ts"
],
"setupFiles": [
"react-app-polyfill/jsdom"
],
"setupFilesAfterEnv": [
"<rootDir>/jest-test-setup.js"
],
"testMatch": [
"<rootDir>/src/**/__tests__/**/*.{js,jsx,ts,tsx}",
"<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}"
],
"testEnvironment": "jest-environment-jsdom-fourteen",
"transform": {
"^.+\\.(js|jsx|ts|tsx)$": "<rootDir>/node_modules/babel-jest",
"^.+\\.css$": "<rootDir>/config/jest/cssTransform.js",
"^(?!.*\\.(js|jsx|ts|tsx|css|json)$)": "<rootDir>/config/jest/fileTransform.js"
},
"transformIgnorePatterns": [
"[/\\\\]node_modules[/\\\\].+\\.(js|jsx|ts|tsx)$",
"^.+\\.module\\.(css|sass|scss)$"
],
"modulePaths": [],
"moduleNameMapper": {
"^react-native$": "react-native-web",
"^.+\\.module\\.(css|sass|scss)$": "identity-obj-proxy"
},
"moduleFileExtensions": [
"web.js",
"js",
"web.ts",
"ts",
"web.tsx",
"tsx",
"json",
"web.jsx",
"jsx",
"node"
],
"watchPlugins": [
"jest-watch-typeahead/filename",
"jest-watch-typeahead/testname"
]
}
}
我認為 Flow 還沒有解決這個問題的方法。 但我和你在同一條船上。
您的消費者無法使用您的 package 類型的原因幾乎是因為他們從.*/flow-typed/*
中讀取全局類型,而不是您的,當他們安裝 package 時將在.*/node_modules/@company/react-common-components-build-template
。 它與任何 package.json 設置無關。
不過,您有兩種選擇來運送您的 package 類型。
要么將它們作為src
代碼的一部分並允許它們導入它,這意味着您的類型將不再是全局的,您需要導入要在源代碼中使用的類型。 但這意味着你的消費者也可以。
或者將它們保存在您的flowdecls
中並確保它們已發布。 一旦它們是,您的用戶將不得不將您的類型定義復制到他們的flow-typed
目錄中,這現在將使它們在他們的項目中也是全局的。
您可以在 README 中添加如下內容,以便為用戶提供一些見解:
react-common-components-build-template
也在內部使用全局類型定義。 如果您想利用這一點,可以將/node_modules/@company/react-common-components-build-template/flowdecls/myTypes.js
復制到本地流類型目錄。 每次版本升級都復制一次可能是個好主意,這樣您就可以與通過 npm 腳本進行的最新更改保持同步。
"scripts": {
// ...
"postinstall": "cp /node_modules/@company/react-common-components-build-template/flowdecls/myTypes.js flow-typed"
},
第二個選項實際上是我已經使用的,上面是我在我的回購中擁有的。 作為旁注,我建議您將 dir 重命名為flow-typed
並將您的 types 文件重命名為react-common-components-build-template.js
之類的東西,這樣當復制過程發生時,人們不會想知道什么myTypes.js
用於。
Flow 將自動查找相鄰的module.js.flow
聲明文件(如果存在)。
例如,如果您有一個指向dist/index.js
的 main 字段,那么將dist/index.js.flow
添加到您的包的輸出中,它將被用戶的語言服務器拾取。
這看起來是一個非常有用的 package 作為此過程的一部分 - https://www.npmjs.com/package/gen-flow-files
為此,您可以使用:
flow-remove-types
NPM package 將創建沒有流類型的lib/Component1.js
。 或者,如果您願意,可以使用 Babelflow-copy-source
NPM package 這會將流類型文件復制到目標文件夾,其后綴為.flow lib/Component1.js.flow
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.