Docz: New install fails with error: Unable to find plugin "gatsby-theme-docz".
Bug Report
Describe the bug
New install fails with error: Unable to find plugin "gatsby-theme-docz".
A clear and concise description of what the bug is.
I am adding docz to an existing project yarn add docz@next -D
I then add an mdx file and run yarn docz dev and it produces the error message:
UNHANDLED REJECTION Unable to find plugin "gatsby-theme-docz". Perhaps you need to install its package?
Error: Unable to find plugin "gatsby-theme-docz". Perhaps you need to install its package?
λ yarn docz dev
yarn run v1.13.0
$ C:\Users\riha\Documents\webui\node_modules\.bin\docz dev
info No lockfile found.
[1/4] Resolving packages...
warning @types/[email protected]: This is a stub types definition. query-string provides its own type definitions, so you do not need this installed.
error Package "check-line-coverage" refers to a non-existing file '"C:\\Users\\riha\\Documents\\webui\\.docz\\tools\\check-line-coverage"'.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
√ Dependencies checked!
Building app
$ gatsby develop --port 3001
success open and validate gatsby-configs - 0.139 s
ERROR
UNHANDLED REJECTION Unable to find plugin "gatsby-theme-docz". Perhaps you need to install its package?
Error: Unable to find plugin "gatsby-theme-docz". Perhaps you need to install its package?
- load.js:109 resolvePlugin
[webui]/[gatsby]/dist/bootstrap/load-plugins/load.js:109:11
- load.js:152 processPlugin
[webui]/[gatsby]/dist/bootstrap/load-plugins/load.js:152:20
- load.js:171 config.plugins.forEach.plugin
[webui]/[gatsby]/dist/bootstrap/load-plugins/load.js:171:20
- Array.forEach
- load.js:170 module.exports
[webui]/[gatsby]/dist/bootstrap/load-plugins/load.js:170:20
- index.js:58 module.exports
[webui]/[gatsby]/dist/bootstrap/load-plugins/index.js:58:19
- index.js:138 module.exports
[webui]/[gatsby]/dist/bootstrap/index.js:138:34
â ‹ load plugins
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
In order to allow us to quickly reproduce you issue please include a link to a reproduction repository.
I cant do that as its for a work project...
Expected behavior
That it loads and works!
A clear and concise description of what you expected to happen..
Environment
- OS: [Windows 10]
- Node/npm version: [v10.16.3]
Additional context/Screenshots
Add any other context about the problem here. If applicable, add screenshots to help explain.
molebox
All 40 comments
I'm not sure why that's happening, I couldn't reproduce locally.
Could you remove node_modules and the .docz cache and try again ?
rm -rf ./node_modules ./.docz && yarn install && yarn dev
Some questions about your project :
Is it in a yarn or lerna workspace ?
Does it use gatsby ?
rakannimer
on 29 Aug 2019
I'm not sure why that's happening, I couldn't reproduce locally.
Could you remove node_modules and the .docz cache and try again ?
rm -rf ./node_modules ./.docz && yarn install && yarn devSome questions about your project :
Is it in a yarn or lerna workspace ?
Does it use gatsby ?
I have tried do remove both node_modules and the .docz file to no avail.
The project is a react, typescript project. we use yarn. I havent set up a workspace as i was under the impression i could just add docz and then add mdx files next to the components and it would just work I did get a version up and running as a separate project but the whole point of me doing these docs is that i can use the actual components we use in our project so i thought i could just add docz to the project.
We dont use gatsby.
molebox
on 29 Aug 2019
Just a heads up that i upgraded to "docz": "^2.0.0-rc.8" and im still seeing this error.
Some more context:
I have added docz": "^2.0.0-rc.8 and [email protected] and 1 mdx file. I have not added a doczrc.js or anything else.
molebox
on 30 Aug 2019
Noted !
Would you mind sharing the other dependencies in your package.json ?
Or (even better) maybe a small repo with a repro of this problem ?
rakannimer
on 30 Aug 2019
Unfortunately i cant share the repo but i can share our package.json. :
{
"name": "incenter-webui",
"version": "0.1.0",
"description": "InCenter Web User Interface",
"main": "none",
"private": true,
"scripts": {
"test": "yarn run license-check && yarn typecheck && cross-env CONFIG_ENV=test jest --coverage && yarn line-coverage",
"update-snapshot": "cross-env CONFIG_ENV=test jest -u",
"lint": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\" && stylelint \"src/**/*.{less,css}\" \"assets/**/*.{less,css,config,variables,overrides}\" --syntax=less",
"fix-src": "./node_modules/.bin/eslint \"src/**/*.{ts,tsx,js}\" --fix",
"fix-less": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" --fix",
"fix-tests": "./node_modules/.bin/eslint \"__tests__/**/*.{ts,tsx,js}\" --fix",
"line-coverage": "node ./node_modules/check-line-coverage \"coverage/clover.xml\" \"80\"",
"bamboo-lint": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\" -f node_modules/eslint-bamboo-formatter/reporter.js && stylelint \"src/**/*.{less,css}\" \"assets/**/*.{less,css,config,variables,overrides}\" --syntax=less --custom-formatter node_modules/stylelint-mocha-formatter/index.js > stylelint.json || true",
"dev": "cross-env OEM=incenter webpack-dev-server --inline -d",
"dev-production": "cross-env NODE_ENV=production webpack-dev-server --inline --mode=production --devtool 'source-map' --progress",
"build": "cross-env NODE_ENV=production webpack -p",
"build-dev": "cross-env NODE_ENV=development webpack --mode=production --devtool 'source-map' --progress",
"build-watch": "webpack --watch --devtool 'source-map' --mode=production --progress",
"test:watch": "jest --watchAll",
"typecheck": "tsc --noEmit -p .",
"license-check": "node ./node_modules/@clavister/license-check/licenseCheck.js --verify --paths=. -o=missingLicenses.json",
"analyze": "cross-env NODE_ENV=production ANALYZE=true webpack -p",
"eslint-check-rules": "./node_modules/.bin/eslint --print-config . | eslint-config-prettier-check",
"pretty-check": "prettier --check \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\"",
"pretty": "prettier --write \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\""
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"src/**/*.{js,ts,tsx}": [
"yarn pretty-check",
"git add"
],
"src/**/*.{less,css}": [
"stylelint --fix",
"git add"
]
},
"repository": {
"type": "git",
"url": "ssh://[email protected]:7999/ems/webui.git"
},
"keywords": [
"incenter",
"webui"
],
"author": "Clavister",
"license": "CLAVISTER",
"dependencies": {
"@clavister/configuration-categories": "^1.0.0",
"@clavister/globalObjectsWhitelist": "^1.0.2",
"@clavister/socketEvent": "^2.0.4",
"@types/enzyme": "^3.1.6",
"@types/file-saver": "^1.3.0",
"@types/jest": "^21.1.3",
"@types/jsonwebtoken": "^8.3.0",
"@types/memoize-one": "^4.1.0",
"@types/mousetrap": "^1.5.34",
"@types/node": "^11.10.4",
"@types/query-string": "^6.1.0",
"@types/react": "^16.9.2",
"@types/react-dom": "^16.9.0",
"@types/react-grid-layout": "^0.14.3",
"@types/react-redux": "^6.0.6",
"@types/react-router-dom": "^4.0.7",
"@types/react-virtualized": "^9.7.4",
"@types/redux-mock-store": "^1.0.0",
"@types/rison": "^0.0.6",
"@types/shallowequal": "^1.1.1",
"@types/webpack-env": "^1.13.7",
"fast-deep-equal": "^2.0.1",
"file-saver": "^1.3.8",
"focus-trap-react": "^3.1.2",
"js-logger": "^1.4.1",
"jsonwebtoken": "^8.0.1",
"memoize-one": "^5.0.0",
"mousetrap": "^1.6.1",
"prop-types": "^15.6.2",
"query-string": "^6.1.0",
"react": "~16.9.0 ",
"react-cookie": "2.2.0",
"react-dom": "~16.9.0",
"react-grid-layout": "^0.15.3",
"react-markdown": "^4.0.6",
"react-redux": "^5.0.7",
"react-router-dom": "^4.2.2",
"react-sizeme": "^2.5.2",
"react-virtualized": "^9.10.1",
"redux": "^4.0.0",
"redux-store-observer": "^1.0.0",
"redux-thunk": "^2.3.0",
"reselect": "^3.0.1",
"rison": "^0.1.1",
"scheduler": "0.15.0",
"semantic-ui-less": "^2.3.3",
"semantic-ui-react": "^0.83.0",
"shallowequal": "^1.1.0",
"toml": "^3.0.0",
"tslib": "^1.9.3",
"typeface-open-sans": "^0.0.54"
},
"devDependencies": {
"@babel/core": "^7.0.0",
"@babel/plugin-proposal-class-properties": "^7.0.0",
"@babel/plugin-proposal-object-rest-spread": "^7.0.0",
"@babel/preset-env": "^7.1.0",
"@babel/preset-react": "^7.0.0",
"@clavister/license-check": "^1.0.0",
"@svgr/webpack": "^4.1.0",
"@typescript-eslint/eslint-plugin": "^1.7.0",
"@typescript-eslint/parser": "^1.7.0",
"babel-core": "^7.0.0-bridge.0",
"babel-eslint": "^10.0.0",
"babel-jest": "^24.1.0",
"babel-loader": "^8.0.2",
"babel-plugin-js-logger": "^1.0.16",
"babel-plugin-transform-class-properties": "^6.24.1",
"check-line-coverage": "file:tools/check-line-coverage",
"cross-env": "^3.2.4",
"css-loader": "^1.0.0",
"docz": "^2.0.0-rc.8",
"enzyme": "^3.3.0",
"enzyme-adapter-react-16": "^1.1.1",
"enzyme-to-json": "^3.3.0",
"eslint": "^5.16.0",
"eslint-bamboo-formatter": "^0.1.0",
"eslint-config-prettier": "^4.2.0",
"eslint-loader": "^2.1.1",
"eslint-plugin-import": "^2.17.2",
"eslint-plugin-jsdoc": "^4.8.3",
"eslint-plugin-no-null": "^1.0.2",
"eslint-plugin-prefer-arrow": "^1.1.5",
"eslint-plugin-prettier": "^3.0.1",
"eslint-plugin-promise": "^4.1.1",
"eslint-plugin-react": "^7.12.4",
"eslint-plugin-react-hooks": "^1.0.1",
"file-loader": "^2.0.0",
"fork-ts-checker-webpack-plugin": "^0.5.2",
"html-webpack-plugin": "^3.2.0",
"husky": "^1.2.0",
"identity-obj-proxy": "^3.0.0",
"jest": "^24.1.0",
"jest-bamboo-formatter": "^1.0.1",
"jest-enzyme": "^7.0.1",
"jest-fetch-mock": "^1.6.6",
"jest-localstorage-mock": "^2.2.0",
"json-loader": "^0.5.4",
"less": "^3.9.0",
"less-loader": "^4.1.0",
"lint-staged": "^8.1.5",
"mini-css-extract-plugin": "^0.5.0",
"mock-socket": "^8.0.4",
"nock": "^9.0.14",
"prettier": "^1.17.0",
"redux-mock-store": "^1.5.3",
"style-loader": "^0.23.0",
"stylelint": "^9.10.1",
"stylelint-mocha-formatter": "file:tools/stylelint-mocha-formatter",
"svgo": "^1.2.0",
"svgo-loader": "^2.2.0",
"ts-jest": "^24.0.0",
"ts-loader": "^5.3.3",
"typescript": "~3.4.3",
"typings-for-css-modules-loader": "^1.5.0",
"url-loader": "^1.1.1",
"webpack": "^4.20.2",
"webpack-bundle-analyzer": "^3.0.4",
"webpack-cli": "^3.1.1",
"webpack-dev-server": "^3.1.11",
"yml-loader": "^2.1.0"
},
"jest": {
"moduleNameMapper": {
"app.yml": "<rootDir>/__mocks__/appConfigMock.js",
"\\.(css|less)$": "identity-obj-proxy"
},
"transform": {
"^.+[\\\\|\\/]assets[\\\\|\\/]icons[\\\\|\\/].+\\.svg$": "<rootDir>/__transforms__/iconFileTransform.js",
"^.+\\.(svg|jpg|jpeg|png)$": "<rootDir>/__transforms__/filePathTransform.js"
},
"transformIgnorePatterns": [
"<rootDir>/node_modules"
],
"modulePaths": [
"<rootDir>/src",
"<rootDir>"
],
"testMatch": [
"**/__tests__/**/*.(spec|test).(js|jsx|ts|tsx)"
],
"collectCoverageFrom": [
"**/src/**/*.{js,jsx,ts,tsx}",
"!**/src/**/*.d.ts",
"!**/node_modules/**",
"!**/src/domain/gateway/mockGateways.ts"
],
"moduleFileExtensions": [
"js",
"json",
"jsx",
"ts",
"tsx"
],
"setupFilesAfterEnv": [
"<rootDir>/jestSetup.js"
],
"collectCoverage": false,
"testResultsProcessor": "<rootDir>/node_modules/jest-bamboo-formatter",
"snapshotSerializers": [
"enzyme-to-json/serializer"
],
"setupFiles": [
"jest-localstorage-mock",
"raf/polyfill"
],
"preset": "ts-jest/presets/js-with-ts"
}
}
Hey! Just wondering if you guys have had a chance to look into this? I know you are super busy with the other issues...
molebox
on 4 Sep 2019
Hey @molebox
yep I've looked into it and was able to reproduce it, it should be solved with [email protected] but your issue could be different than my repro.
Could you give it a try ?
rm -rf .docz && yarn add docz@next && yarn docz dev
If it still happens, could you also provide the .docz/package.json file ?
And try : cd .docz/ && yarn && yarn dev
rakannimer
on 4 Sep 2019
Hey @rakannimer
Thanks for looking into this, we are eager to get this up and running at our company.
Unfortunately its still not working and showing the same error. When i run rm -rf .docz && yarn add docz@next && yarn docz dev I get the following question:
Here is the .docz/package.json :
{
"name": "incenter-webui",
"version": "0.1.0",
"description": "InCenter Web User Interface",
"main": "none",
"private": true,
"scripts": {
"test": "yarn run license-check && yarn typecheck && cross-env CONFIG_ENV=test jest --coverage && yarn line-coverage",
"update-snapshot": "cross-env CONFIG_ENV=test jest -u",
"lint": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\" && stylelint \"src/**/*.{less,css}\" \"assets/**/*.{less,css,config,variables,overrides}\" --syntax=less",
"fix-src": "./node_modules/.bin/eslint \"src/**/*.{ts,tsx,js}\" --fix",
"fix-less": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" --fix",
"fix-tests": "./node_modules/.bin/eslint \"__tests__/**/*.{ts,tsx,js}\" --fix",
"line-coverage": "node ./node_modules/check-line-coverage \"coverage/clover.xml\" \"80\"",
"bamboo-lint": "./node_modules/.bin/eslint \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\" -f node_modules/eslint-bamboo-formatter/reporter.js && stylelint \"src/**/*.{less,css}\" \"assets/**/*.{less,css,config,variables,overrides}\" --syntax=less --custom-formatter node_modules/stylelint-mocha-formatter/index.js > stylelint.json || true",
"dev": "gatsby develop",
"dev-production": "cross-env NODE_ENV=production webpack-dev-server --inline --mode=production --devtool 'source-map' --progress",
"build": "gatsby build",
"build-dev": "cross-env NODE_ENV=development webpack --mode=production --devtool 'source-map' --progress",
"build-watch": "webpack --watch --devtool 'source-map' --mode=production --progress",
"test:watch": "jest --watchAll",
"typecheck": "tsc --noEmit -p .",
"license-check": "node ./node_modules/@clavister/license-check/licenseCheck.js --verify --paths=. -o=missingLicenses.json",
"analyze": "cross-env NODE_ENV=production ANALYZE=true webpack -p",
"eslint-check-rules": "./node_modules/.bin/eslint --print-config . | eslint-config-prettier-check",
"pretty-check": "prettier --check \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\"",
"pretty": "prettier --write \"src/**/*.less.d.ts\" \"src/**/*.{ts,tsx,js}\" \"__tests__/**/*.{ts,tsx,js}\"",
"serve": "gatsby serve"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"src/**/*.{js,ts,tsx}": [
"yarn pretty-check",
"git add"
],
"src/**/*.{less,css}": [
"stylelint --fix",
"git add"
]
},
"repository": {
"type": "git",
"url": "ssh://[email protected]:7999/ems/webui.git"
},
"keywords": [
"incenter",
"webui"
],
"author": "Clavister",
"license": "CLAVISTER",
"dependencies": {
"@clavister/configuration-categories": "^1.0.0",
"@clavister/globalObjectsWhitelist": "^1.0.2",
"@clavister/socketEvent": "^2.0.4",
"@types/enzyme": "^3.1.6",
"@types/file-saver": "^1.3.0",
"@types/jest": "^21.1.3",
"@types/jsonwebtoken": "^8.3.0",
"@types/memoize-one": "^4.1.0",
"@types/mousetrap": "^1.5.34",
"@types/node": "^11.10.4",
"@types/query-string": "^6.1.0",
"@types/react": "^16.9.2",
"@types/react-dom": "^16.9.0",
"@types/react-grid-layout": "^0.14.3",
"@types/react-redux": "^6.0.6",
"@types/react-router-dom": "^4.0.7",
"@types/react-virtualized": "^9.7.4",
"@types/redux-mock-store": "^1.0.0",
"@types/rison": "^0.0.6",
"@types/shallowequal": "^1.1.1",
"@types/webpack-env": "^1.13.7",
"fast-deep-equal": "^2.0.1",
"file-saver": "^1.3.8",
"focus-trap-react": "^3.1.2",
"js-logger": "^1.4.1",
"jsonwebtoken": "^8.0.1",
"memoize-one": "^5.0.0",
"mousetrap": "^1.6.1",
"prop-types": "^15.6.2",
"query-string": "^6.1.0",
"react": "~16.9.0 ",
"react-cookie": "2.2.0",
"react-dom": "~16.9.0",
"react-grid-layout": "^0.15.3",
"react-markdown": "^4.0.6",
"react-redux": "^5.0.7",
"react-router-dom": "^4.2.2",
"react-sizeme": "^2.5.2",
"react-virtualized": "^9.10.1",
"redux": "^4.0.0",
"redux-store-observer": "^1.0.0",
"redux-thunk": "^2.3.0",
"reselect": "^3.0.1",
"rison": "^0.1.1",
"semantic-ui-less": "^2.3.3",
"semantic-ui-react": "^0.83.0",
"shallowequal": "^1.1.0",
"toml": "^3.0.0",
"tslib": "^1.9.3",
"typeface-open-sans": "^0.0.54",
"gatsby": "2.15.6",
"gatsby-plugin-typescript": "2.1.6",
"gatsby-plugin-eslint": "2.0.5",
"gatsby-theme-docz": "^2.0.0-rc.31"
},
"devDependencies": {
"@babel/core": "^7.0.0",
"@babel/plugin-proposal-class-properties": "^7.0.0",
"@babel/plugin-proposal-object-rest-spread": "^7.0.0",
"@babel/preset-env": "^7.1.0",
"@babel/preset-react": "^7.0.0",
"@clavister/license-check": "^1.0.0",
"@svgr/webpack": "^4.1.0",
"@typescript-eslint/eslint-plugin": "^1.7.0",
"@typescript-eslint/parser": "^1.7.0",
"babel-core": "^7.0.0-bridge.0",
"babel-eslint": "^10.0.0",
"babel-jest": "^24.1.0",
"babel-loader": "^8.0.2",
"babel-plugin-js-logger": "^1.0.16",
"babel-plugin-transform-class-properties": "^6.24.1",
"check-line-coverage": "file:tools/check-line-coverage",
"cross-env": "^3.2.4",
"css-loader": "^1.0.0",
"docz": "^2.0.0-rc.31",
"enzyme": "^3.3.0",
"enzyme-adapter-react-16": "^1.1.1",
"enzyme-to-json": "^3.3.0",
"eslint": "^5.16.0",
"eslint-bamboo-formatter": "^0.1.0",
"eslint-config-prettier": "^4.2.0",
"eslint-loader": "^2.1.1",
"eslint-plugin-import": "^2.17.2",
"eslint-plugin-jsdoc": "^4.8.3",
"eslint-plugin-no-null": "^1.0.2",
"eslint-plugin-prefer-arrow": "^1.1.5",
"eslint-plugin-prettier": "^3.0.1",
"eslint-plugin-promise": "^4.1.1",
"eslint-plugin-react": "^7.12.4",
"eslint-plugin-react-hooks": "^1.0.1",
"file-loader": "^2.0.0",
"fork-ts-checker-webpack-plugin": "^0.5.2",
"html-webpack-plugin": "^3.2.0",
"husky": "^1.2.0",
"identity-obj-proxy": "^3.0.0",
"jest": "^24.1.0",
"jest-bamboo-formatter": "^1.0.1",
"jest-enzyme": "^7.0.1",
"jest-fetch-mock": "^1.6.6",
"jest-localstorage-mock": "^2.2.0",
"json-loader": "^0.5.4",
"less": "^3.9.0",
"less-loader": "^4.1.0",
"lint-staged": "^8.1.5",
"mini-css-extract-plugin": "^0.5.0",
"mock-socket": "^8.0.4",
"nock": "^9.0.14",
"prettier": "^1.17.0",
"redux-mock-store": "^1.5.3",
"style-loader": "^0.23.0",
"stylelint": "^9.10.1",
"stylelint-mocha-formatter": "file:tools/stylelint-mocha-formatter",
"svgo": "^1.2.0",
"svgo-loader": "^2.2.0",
"ts-jest": "^24.0.0",
"ts-loader": "^5.3.3",
"typescript": "~3.4.3",
"typings-for-css-modules-loader": "^1.5.0",
"url-loader": "^1.1.1",
"webpack": "^4.20.2",
"webpack-bundle-analyzer": "^3.0.4",
"webpack-cli": "^3.1.1",
"webpack-dev-server": "^3.1.11",
"yml-loader": "^2.1.0"
},
"jest": {
"moduleNameMapper": {
"app.yml": "<rootDir>/__mocks__/appConfigMock.js",
"\\.(css|less)$": "identity-obj-proxy"
},
"transform": {
"^.+[\\\\|\\/]assets[\\\\|\\/]icons[\\\\|\\/].+\\.svg$": "<rootDir>/__transforms__/iconFileTransform.js",
"^.+\\.(svg|jpg|jpeg|png)$": "<rootDir>/__transforms__/filePathTransform.js"
},
"transformIgnorePatterns": [
"<rootDir>/node_modules"
],
"modulePaths": [
"<rootDir>/src",
"<rootDir>"
],
"testMatch": [
"**/__tests__/**/*.(spec|test).(js|jsx|ts|tsx)"
],
"collectCoverageFrom": [
"**/src/**/*.{js,jsx,ts,tsx}",
"!**/src/**/*.d.ts",
"!**/node_modules/**",
"!**/src/domain/gateway/mockGateways.ts"
],
"moduleFileExtensions": [
"js",
"json",
"jsx",
"ts",
"tsx"
],
"setupFilesAfterEnv": [
"<rootDir>/jestSetup.js"
],
"collectCoverage": false,
"testResultsProcessor": "<rootDir>/node_modules/jest-bamboo-formatter",
"snapshotSerializers": [
"enzyme-to-json/serializer"
],
"setupFiles": [
"jest-localstorage-mock",
"raf/polyfill"
],
"preset": "ts-jest/presets/js-with-ts"
}
}
It looks to be the same as the current projects package.json.... IS that correct? should it just copy over?
I just did a clean branch of our project, ran yarn add docz@next -D then yarn docz dev It didnt work so i added a doczrc.js file and copied the typescript example. I also added a single mdx file located within our current project with its route set to /
Hope this info helps, would love to get this working!
molebox
on 4 Sep 2019
Jeez, sorry for the formatting! How do i tab the code inwards?
molebox
on 4 Sep 2019
Could you try (temporarily) removing all local packages in your main package.json ?
Local packages are packages that have a filesystem path instead of a version like :
{
"check-line-coverage": "file:tools/check-line-coverage",
"stylelint-mocha-formatter": "file:tools/stylelint-mocha-formatter",
}
then run :
rm -rf .docz && yarn docz dev
Ok so removing those two meant the error went away! However i see another error when its checking the dependencies:
C:\Users\riha\Documents\webui (test/docs -> origin)
λ yarn docz dev
yarn run v1.13.0
$ C:\Users\riha\Documents\webuinode_modules.bindocz dev
Browserslist: caniuse-lite is outdated. Please run next commandyarn upgrade caniuse-lite browserslist
info No lockfile found.
[1/4] Resolving packages...
warning @types/[email protected]: This is a stub types definition. query-string provides its own type definitions, so you do not need this installed.
warning gatsby > @reach/router > create-react-context > fbjs > [email protected]: core-js@<2.6.8 is no longer maintained. Please, upgrade to core-js@3 or at least to actual version of core-js@2.
warning jest > jest-cli > jest-config > jest-environment-jsdom > jsdom > [email protected]: use String.prototype.padStart()
[2/4] Fetching packages...
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
[3/4] Linking dependencies...
warning "gatsby > [email protected]" has incorrect peer dependency "[email protected]".
warning " > [email protected]" has unmet peer dependency "tslint@^4.0.0 || ^5.0.0".
[4/4] Building fresh packages...
[-/6] ⢀ waiting...
[-/6] ⢀ waiting...
[-/6] ⢀ waiting...
[-/6] â waiting...
error C:\Users\riha\Documents\webui.docznode_modulessharp: Command failed.
Exit code: 1
Command: (node install/libvips && node install/dll-copy && prebuild-install) || (node-gyp rebuild && node install/dll-copy)
Arguments:
Directory: C:\Users\riha\Documents\webui.docznode_modulessharp
Output:
info sharp Downloading https://github.com/lovell/sharp-libvips/releases/download/v8.8.1/libvips-8.8.1-win32-x64.tar.gz
C:\Users\riha\Documents\webui.docznode_modulessharp\install\libvips.js:82
throw err;
^
Error: connect ECONNREFUSED 140.82.118.3:443
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1106:14)
gyp info it worked if it ends with ok
gyp info using [email protected]
gyp info using [email protected] | win32 | x64
C:\Users\riha\Documents\webui.docznode_modulessharp>if not defined npm_config_node_gyp (node "C:\Program Filesnodejsnode_modules\npm\binnode-gyp-bin\....node_modulesnode-gyp\binnode-gyp.js" rebuild ) else (node "" rebuild )
gyp info spawn C:\Python27\python.exe
gyp info spawn args [ 'C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\gyp\gyp_main.py',
gyp info spawn args 'binding.gyp',
gyp info spawn args '-f',
gyp info spawn args 'msvs',
gyp info spawn args '-G',
gyp info spawn args 'msvs_version=2015',
gyp info spawn args '-I',
gyp info spawn args 'C:\Users\riha\Documents\webui\.docz\node_modules\sharp\build\config.gypi',
gyp info spawn args '-I',
gyp info spawn args 'C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\addon.gypi',
gyp info spawn args '-I',
gyp info spawn args 'C:\Users\riha\.node-gyp\10.16.3\include\node\common.gypi',
gyp info spawn args '-Dlibrary=shared_library',
gyp info spawn args '-Dvisibility=default',
gyp info spawn args '-Dnode_root_dir=C:\Users\riha\.node-gyp\10.16.3',
gyp info spawn args '-Dnode_gyp_dir=C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp',
gyp info spawn args '-Dnode_lib_file=C:\Users\riha\.node-gyp\10.16.3\<(target_arch)\node.lib',
gyp info spawn args '-Dmodule_root_dir=C:\Users\riha\Documents\webui\.docz\node_modules\sharp',
gyp info spawn args '-Dnode_engine=v8',
gyp info spawn args '--depth=.',
gyp info spawn args '--no-parallel',
gyp info spawn args '--generator-output',
gyp info spawn args 'C:\Users\riha\Documents\webui\.docz\node_modules\sharp\build',
gyp info spawn args '-Goutput_dir=.' ]
gyp info spawn C:\Program Files (x86)\MSBuild\14.0\bin\msbuild.exe
gyp info spawn args [ 'build/binding.sln',
gyp info spawn args '/clp:Verbosity=minimal',
gyp info spawn args '/nologo',
gyp info spawn args '/p:Configuration=Release;Platform=x64' ]
Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch.
VError.cpp
VInterpolate.cpp
VImage.cpp
win_delay_load_hook.cc
..\src\libvips\cplusplus\VInterpolate.cpp(34): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webui.docznode_modulessharp\build\libvips-cpp.vcxproj]
..\src\libvips\cplusplus\VError.cpp(33): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webui.docznode_modulessharp\build\libvips-cpp.vcxproj]
..\src\libvips\cplusplus\VImage.cpp(41): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webui.docznode_modulessharp\build\libvips-cpp.vcxproj]
gyp ERR! build error
gyp ERR! stack Error: C:\Program Files (x86)\MSBuild\14.0\bin\msbuild.exe failed with exit code: 1
gyp ERR! stack at ChildProcess.onExit (C:\Program Filesnodejsnode_modules\npmnode_modulesnode-gyp\lib\build.js:262:23)
gyp ERR! stack at ChildProcess.emit (events.js:198:13)
gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:248:12)
gyp ERR! System Windows_NT 10.0.17763
gyp ERR! command "C:\Program Files\nodejs\node.exe" "C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js" "rebuild"
gyp ERR! cwd C:\Users\riha\Documents\webui.docznode_modulessharp
√ Dependencies checked!
Its does however build but i get TypeError: Cannot read property 'frontmatter' of undefined
this is the mdx file:
name: Button
route: /
import { Playground, Props } from 'docz'
import Button from './Button'
Im a button
This is the doczrc.js:
export default {
typescript: true,
title: 'Docz Typescript',
menu: ['Getting Started'],
};
molebox
on 4 Sep 2019
So i cannot have any local packages on my package.json? The ones that have file? For Docz to work?
molebox
on 4 Sep 2019
Ok so it looks like im up and running! Im just having problems with this frontmatter error but the docz are now loading.
I'll close this issue once i know why i cant use the local packages in the package.json. Thanks again for all your help by the way! :)
molebox
on 4 Sep 2019
So i cannot have any local packages on my package.json? The ones that have file? For Docz to work?
Hopefully that won't be a problem by the time official v2 is out.
I'm working on something that should get rid of that problem but it's not very easy so it might take a bit of time to get it right.
Meanwhile 2 questions :
- Are you using an npmrc file in your project by any chance ?
- If you go to a different directory and run :
npx create-docz-app docz-app-test && cd docz-app-test && yarn dev
does it work ? (trying to see if the problem is from windows or if it's your particular set of dependencies)
rakannimer
on 4 Sep 2019
We dont have an npmrc file. We have an .yarnrc file though.. Would that make a difference? Would you still like me to test running npx create-docz-app docz-app-test && cd docz-app-test && yarn dev ?
molebox
on 4 Sep 2019
Yes the .yarnrc might be the source of the problem.
docz doesn't copy it to the internal .docz folder. (This is a bug, not a feature)
Could you try running the command in a separate folder just to confirm docz is working as expected on your machine.
npx create-docz-app docz-app-test && cd docz-app-test && yarn dev
Sorry, im behind a corporate proxy so cant run that command...
molebox
on 4 Sep 2019
Ok no problem.
One last request, could you try in your project :
rm -rf .docz/node_modules && cp .yarnrc .docz/.yarnrc && yarn && yarn dev
I ran rm -rf .docz/node_modules && cp .yarnrc .docz/.yarnrc && yarn && yarn docz dev? With docz dev at the end instead of yarn dev. Everything loads except im still seeing this frontmatter error in the playground:
My ContentHeader Component:
My doczrc.js:
// import {css} from 'docz-plugin-css';
export default {
typescript: true,
title: 'Docz Typescript',
menu: ['Getting Started', 'Components'],
notUseSpecifiers: true,
filterComponents: (files) => files.filter((filepath) => /[w-]*.(js|jsx|ts|tsx)$/.test(filepath)),
// plugins: [
// css({
// preprocessor: 'less',
// }),
// ],
};
I did try installing the docz-plugin-css but it then threw an error saying it couldnt find gatsby-plugin-mdx:
UNHANDLED REJECTION Unable to find plugin "gatsby-plugin-mdx". Perhaps you need to install its package?
Error: Unable to find plugin "gatsby-plugin-mdx". Perhaps you need to install its package?
load.js:109 resolvePlugin
[.docz]/[gatsby]/dist/bootstrap/load-plugins/load.js:109:11load.js:153 processPlugin
[.docz]/[gatsby]/dist/bootstrap/load-plugins/load.js:153:20load.js:172 config.plugins.forEach.plugin
[.docz]/[gatsby]/dist/bootstrap/load-plugins/load.js:172:20Array.forEach
load.js:171 module.exports
[.docz]/[gatsby]/dist/bootstrap/load-plugins/load.js:171:20index.js:58 module.exports
[.docz]/[gatsby]/dist/bootstrap/load-plugins/index.js:58:19index.js:136 module.exports
[.docz]/[gatsby]/dist/bootstrap/index.js:136:34
molebox
on 4 Sep 2019
Hey,
I released a new version that doesn't need to install any dependencies.
Could you try it ?
yarn remove docz && yarn add [email protected] && yarn docz dev
Hey!
Strange im getting this when running that command:
Couldn't find any versions for "docz" that matches "2.0.0-rc.33"
? Please choose a version of "docz" from this list: (Use arrow keys)
I'll run it from @next
molebox
on 4 Sep 2019
It probably hasn't properly propagated yet ( released it minutes ago ).
rakannimer
on 4 Sep 2019
But I'm pretty sure it's the right version : https://www.npmjs.com/package/docz/v/2.0.0-rc.33
rakannimer
on 4 Sep 2019
But I'm pretty sure it's the right version : https://www.npmjs.com/package/docz/v/2.0.0-rc.33
Yeah i saw that, running it now as docz@next
molebox
on 4 Sep 2019
Is the goal here to remove the frontmatter error? If so its still there. It seems as though the findEntry function in gatsby-theme-docz/src/base/Layout cant figure out line 29 : const isIndex = ctx.frontmatter.route === '/'
molebox
on 4 Sep 2019
hang on it installed rc-31. I'll run it again
molebox
on 4 Sep 2019
And please make sure to delete .docz folder too
rakannimer
on 4 Sep 2019
I guess i have to wait a bit as its still installing rc-31 as next and asking me to choose a version if i specify rc-33. I'll try again in..... 10 mins? Not sure how long it takes for npm to push it out
molebox
on 4 Sep 2019
This is very odd. Im still not able to install [email protected]
molebox
on 4 Sep 2019
Was finally able to install the latest version (rc-35 at the time of writing) but unfortunatley it seems that something is broken:
C:\Users\riha\Documents\webui (test/docs -> origin)
λ yarn add docz@next && yarn docz dev
yarn add v1.17.3
[1/4] Resolving packages...
warning docz > docz-components > react-live > create-react-context > fbjs > [email protected]: core-js@<2.6.8 is no longer maintained. Please, upgrade to core-js@3 or at least to actual version of core-js@2.
[2/4] Fetching packages...
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
[3/4] Linking dependencies...
warning " > [email protected]" has unmet peer dependency "tslint@^4.0.0 || ^5.0.0".
warning "docz > gatsby-plugin-typescript > [email protected]" has unmet peer dependency "graphql@^14.1.1".
warning "docz > gatsby > [email protected]" has incorrect peer dependency "[email protected]".
[4/4] Building fresh packages...
[-/6] â „ waiting...
[-/6] â „ waiting...
[6/6] â „ sharp
[-/6] â „ waiting...
error C:\Users\riha\Documents\webuinode_modulessharp: Command failed.
Exit code: 1
Command: (node install/libvips && node install/dll-copy && prebuild-install) || (node-gyp rebuild && node install/dll-copy)
Arguments:
Directory: C:\Users\riha\Documents\webuinode_modulessharp
Output:
info sharp Downloading https://github.com/lovell/sharp-libvips/releases/download/v8.8.1/libvips-8.8.1-win32-x64.tar.gz
C:\Users\riha\Documents\webuinode_modulessharp\install\libvips.js:82
throw err;
^
Error: connect ECONNREFUSED 140.82.118.3:443
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1106:14)
C:\Users\riha\Documents\webuinode_modulessharp>if not defined npm_config_node_gyp (node "C:\Program Filesnodejsnode_modules\npm\binnode-gyp-bin\....node_modulesnode-gyp\binnode-gyp.js" rebuild ) else (node "" rebuild )
gyp info it worked if it ends with ok
gyp info using [email protected]
gyp info using [email protected] | win32 | x64
gyp info spawn C:\Python27\python.exe
gyp info spawn args [ 'C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\gyp\gyp_main.py',
gyp info spawn args 'binding.gyp',
gyp info spawn args '-f',
gyp info spawn args 'msvs',
gyp info spawn args '-G',
gyp info spawn args 'msvs_version=2015',
gyp info spawn args '-I',
gyp info spawn args 'C:\Users\riha\Documents\webui\node_modules\sharp\build\config.gypi',
gyp info spawn args '-I',
gyp info spawn args 'C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\addon.gypi',
gyp info spawn args '-I',
gyp info spawn args 'C:\Users\riha\.node-gyp\10.16.3\include\node\common.gypi',
gyp info spawn args '-Dlibrary=shared_library',
gyp info spawn args '-Dvisibility=default',
gyp info spawn args '-Dnode_root_dir=C:\Users\riha\.node-gyp\10.16.3',
gyp info spawn args '-Dnode_gyp_dir=C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp',
gyp info spawn args '-Dnode_lib_file=C:\Users\riha\.node-gyp\10.16.3\<(target_arch)\node.lib',
gyp info spawn args '-Dmodule_root_dir=C:\Users\riha\Documents\webui\node_modules\sharp',
gyp info spawn args '-Dnode_engine=v8',
gyp info spawn args '--depth=.',
gyp info spawn args '--no-parallel',
gyp info spawn args '--generator-output',
gyp info spawn args 'C:\Users\riha\Documents\webui\node_modules\sharp\build',
gyp info spawn args '-Goutput_dir=.' ]
gyp info spawn C:\Program Files (x86)\MSBuild\14.0\bin\msbuild.exe
gyp info spawn args [ 'build/binding.sln',
gyp info spawn args '/clp:Verbosity=minimal',
gyp info spawn args '/nologo',
gyp info spawn args '/p:Configuration=Release;Platform=x64' ]
Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch.
VError.cpp
VInterpolate.cpp
VImage.cpp
win_delay_load_hook.cc
..\src\libvips\cplusplus\VError.cpp(33): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webuinode_modulessharp\build\libvips-cpp.vcxproj]
..\src\libvips\cplusplus\VInterpolate.cpp(34): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webuinode_modulessharp\build\libvips-cpp.vcxproj]
..\src\libvips\cplusplus\VImage.cpp(41): fatal error C1083: Cannot open include file: 'vips/intl.h': No such file or directory [C:\Users\riha\Documents\webuinode_modulessharp\build\libvips-cpp.vcxproj]
gyp ERR! build error
gyp ERR! stack Error: C:\Program Files (x86)\MSBuild\14.0\bin\msbuild.exe failed with exit code: 1
gyp ERR! stack at ChildProcess.onExit (C:\Program Filesnodejsnode_modules\npmnode_modulesnode-gyp\lib\build.js:262:23)
gyp ERR! stack at ChildProcess.emit (events.js:198:13)
gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:248:12)
gyp ERR! System Windows_NT 10.0.17763
gyp ERR! command "C:\Program Files\nodejs\node.exe" "C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js" "rebuild"
gyp ERR! cwd C:\Users\riha\Documents\webuinode_modulessharp
molebox
on 5 Sep 2019
Oh, is this because im behind a corporate proxy?
molebox
on 5 Sep 2019
The problem here looks like it's not directly from docz but from gatsby and the sharp module failing to build
Here are some issues of people with the same problem
https://github.com/gatsbyjs/gatsby/issues/11101
https://github.com/gatsbyjs/gatsby/issues/11026
https://github.com/lovell/sharp/issues/1539
Make sure to check if you can find something that allows you to get through the install.
I would start by trying (commit before you do) :
rm -rf node_modules .docz yarn.lock package-lock.json && yarn
yarn docz dev
Oh, is this because im behind a corporate proxy?
Almost definitely, but I'm not sure how it's failing exactly.
rakannimer
on 5 Sep 2019
The problem here looks like it's not directly from
doczbut fromgatsbyand thesharpmodule failing to buildHere are some issues of people with the same problem
gatsbyjs/gatsby#11101
gatsbyjs/gatsby#11026
lovell/sharp#1539Make sure to check if you can find something that allows you to get through the install.
I would start by trying (commit before you do) :
rm -rf node_modules .docz yarn.lock package-lock.json && yarn yarn docz dev
Thanks for the help! I'll have a look at those and remove node_modules etc... Im hoping today is the day i get this working! :)
molebox
on 5 Sep 2019
@rakannimer may i ask, due to this change:
Hey,
I released a new version that doesn't need to install any dependencies.
Could you try it ?
yarn remove docz && yarn add [email protected] && yarn docz dev
Does that mean that the user installs the dependencies? Hence our firewall at work is blocking it? Im not to savvy with this stuff so i hope that makes sense.. :)
molebox
on 5 Sep 2019
Before 2.0.0-rc.33, docz used to re-install all your dependencies when you call docz dev for the first time, and add to them gatsby-theme-docz (and others)
After 2.0.0-rc.33, docz requires gatsby-theme-docz directly when you install it and doesn't add or install any other dependencies when you run it for the first time.
So to answer your question :
< 2.0.0-rc.33
yarn add docz@next # doesn't install gatsby-theme-docz
yarn docz dev # if it's the first run it would re-install your dependencies + gatsby-theme-docz
>= 2.0.0-rc.33
yarn add docz@next # also installs gatsby-theme-docz as a docz@next dependency
yarn docz dev # doesn't install anything and is very fast
TLDR; I'm not sure the problem is related to the switch between versions 32 - 33 but I might be wrong !
rakannimer
on 5 Sep 2019
Before 2.0.0-rc.33, docz used to re-install all your dependencies when you call docz dev for the first time, and add to them gatsby-theme-docz (and others)
After 2.0.0-rc.33, docz requires gatsby-theme-docz directly when you install it and doesn't add or install any other dependencies when you run it for the first time.
So to answer your question :
< 2.0.0-rc.33
yarn add docz@next # doesn't install gatsby-theme-docz yarn docz dev # if it's the first run it would re-install your dependencies + gatsby-theme-docz>= 2.0.0-rc.33
yarn add docz@next # also installs gatsby-theme-docz as a docz@next dependency yarn docz dev # doesn't install anything and is very fastTLDR; I'm not sure the problem is related to the switch between versions 32 - 33 but I might be wrong !
Ok thanks for clearing that up, it makes much more sense now that you explained it! I dont know why im now getting this error, i doubt its cos of those changes but it would at least install on rc-31 so something is up.
If the problems im having are issues with me being behind the corporate firewall then there isnt much i can do about it ( i work for a network security firm, so they are really strict) Its a shame as i really wanted to use docz for our webui docs.
Thank you so much for your time trying to help me out, really appreciate it. :)
molebox
on 5 Sep 2019
No problem at all, I'm sure if it's happening with you then it's also happening with lots of others and that's a shame !
As a last resort, could you also take a look at this : https://www.gatsbyjs.org/docs/gatsby-on-windows/ ?
And if you have the time, I would appreciate it if you could try setting up a gatsby site https://www.gatsbyjs.org/docs/quick-start/ to see if it would work without docz.
Cheers 😄
rakannimer
on 5 Sep 2019
Sooo I can confirm that gatsby installs correctly. (by using yarn add gatsby, i cant create a site as they do in the example as i cant clone from github at work) I followed the env setup guide you linked and reinstalled some stuff but unfortunately im still getting the same error. :-(
molebox
on 5 Sep 2019
Im closing this issue as my original bug has now been fixed, even though im now encountering separate problems which from what i can tell are related to being behind a corporate firewall.
molebox
on 6 Sep 2019
Related issues
clock157
·
33Comments
tadeuszwojcik
·
30Comments
ohardy
·
24Comments
robjac
·
41Comments
kachkaev
·
31Comments