Экспорт моего собственного типа Flow с пакетом npm?

У меня есть пакет npm компонентов React, которые используют поток для проверки типов.

Было бы полезно, чтобы пользователи моих компонентов имели доступ к моим типам потока. Однако на данный момент я компилирую свой код с помощью 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 без Flow, и мои компоненты широко используются. Однако я действительно хотел бы обеспечить поддержку потока.

В моем последнем случае я пытался использовать flow-copy-source, как указано в этой статье (Создание и публикация модулей JavaScript с помощью Flow), но пользователи моей библиотеки по-прежнему не могут получить доступ к моим типам.

Как сделать такой тип, как DataItemIconType, доступным для тех, кто использует Component1 в моей библиотеке?

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"
    ]
  }
}

person Simon Long    schedule 19.05.2020    source источник
comment
Вы внесли изменения в package.json? Как ваши пользователи пытаются получить доступ к вашим типам потоков? Я думаю, есть альтернативное решение, но я должен попробовать его.   -  person Codebling    schedule 22.05.2020
comment
Да, я включил изменения в свои сценарии package.json, чтобы вызвать поток-копию-источник как часть моей сборки, чтобы в итоге получить то, что у меня есть в lib выше. Мои пользователи будут использовать типы в качестве руководства/помощи структуры, в которой они должны предоставлять данные в мои компоненты. Например, пользователь Component1 (который может быть чем-то вроде таблицы) будет предоставлять данные значка для каждой строки таблицы, используя DataItemIconType. Им было бы полезно показать, как они должны снабжать элемент и что он может иметь цвет и цвет hoverColor.   -  person Simon Long    schedule 22.05.2020
comment
Можешь показать свой package.json   -  person Codebling    schedule 23.05.2020
comment
Обновленный вопрос с package.json   -  person Simon Long    schedule 23.05.2020
comment
@Codebling - Есть еще идеи?   -  person Simon Long    schedule 26.05.2020
comment
Прости Саймон! Не было возможности посмотреть!   -  person Codebling    schedule 26.05.2020
comment
Я заметил еще один пакет Flow, который публиковал свои типы, но делал это отдельно. Однако я все еще убежден, что ваш способ должен работать.   -  person Codebling    schedule 26.05.2020
comment
@Codebling - Нет проблем. Просто любопытно. Попросил некоторых из моих пользователей протестировать это решение, чтобы увидеть, как оно работает.   -  person Simon Long    schedule 27.05.2020
comment
Это странно загруженное время для меня, учитывая пандемию. Я пытался просмотреть вашу посылку, пока не понял, что она частная. (Но публиковать в частном реестре?) Я бы посоветовал загрузить tar-архив для вашего пакета и проверить, есть ли там потоковые файлы. npm игнорирует файлы в вашем .gitignore при сборке. Это была бы моя единственная другая идея, если бы я не запустил ее и не попробовал сам.   -  person Codebling    schedule 27.05.2020


Ответы (4)


Flow будет автоматически искать смежные module.js.flow файлы деклараций, если они есть.

Например, если у вас есть основное поле, указывающее на dist/index.js, то добавление dist/index.js.flow к выходным данным вашего пакета приведет к тому, что оно будет получено языковым сервером пользователя.

person Filip Dupanović    schedule 07.07.2020
comment
Это правда, но я не думаю, что это именно то, о чем просит ОП. Вопрос, насколько я понимаю, больше о том, что, если у библиотеки есть свои собственные файлы объявлений, которые не являются частью исходного кода, а вместо этого являются частью libs (в flowdecls каталоге) - person Brianzchen; 13.07.2020

Я не думаю, что у потока есть решение для этого. Но я был в той же лодке, что и вы.

В значительной степени причина, по которой ваши потребители не могут использовать ваши типы пакетов, заключается в том, что они читают глобальные типы из своего .*/flow-typed/*, а не из вашего, который при установке вашего пакета будет в .*/node_modules/@company/react-common-components-build-template. Это не имеет ничего общего с настройками package.json.

У вас есть два варианта отправки пакета с типами.

Опция 1:

Либо вы помещаете их как часть своего кода src и разрешаете им импортировать его, что означает, что ваши типы больше не будут глобальными, и вам нужно импортировать типы, которые вы хотите использовать в своем исходном коде. Но это означает, что вы можете потребители.

Вариант 2:

Или сохраните их в своем 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"
},

Второй вариант - это то, с чем я пошел, и то, что выше, - это то, что у меня есть в моем репо. В качестве примечания, я бы порекомендовал вам переименовать ваш каталог в flow-typed, а ваш файл типов во что-то вроде react-common-components-build-template.js, чтобы, когда происходит процесс копирования, люди не задавались вопросом, для чего используется myTypes.js.

person Brianzchen    schedule 04.06.2020
comment
Отличный ответ. Именно такие советы и варианты я искал. Большое спасибо. - person Simon Long; 04.06.2020

Это также выглядит очень полезным пакетом как часть этого процесса — https://www.npmjs.com/package/gen-flow-files

person Simon Long    schedule 01.07.2020

Для этого вы можете использовать:

  • flow-remove-types Пакет NPM, который создаст lib/Component1.js без типов потоков. Или сделайте это с Babel, если хотите
  • flow-copy-source Пакет NPM, который будет копировать файлы потокового типа в папку назначения с суффиксом .flow lib/Component1.js.flow
person Max    schedule 27.10.2020