Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation build is broken due #4043

Closed
TheMarex opened this issue May 15, 2017 · 7 comments
Closed

Documentation build is broken due #4043

TheMarex opened this issue May 15, 2017 · 7 comments
Labels

Comments

@TheMarex
Copy link
Member

Building our documentation currently fails with:

  43 | 

  44 | export default class App extends React.PureComponent {

> 45 |   static propTypes = {

     |   ^

  46 |     content: PropTypes.string.isRequired,

  47 |     ast: PropTypes.object.isRequired

  48 |   }

    at File.buildCodeFrameError (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-core/lib/transformation/file/index.js:427:15)

    at NodePath.buildCodeFrameError (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-traverse/lib/path/index.js:140:26)

    at pushBody (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:262:20)

    at buildBody (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:229:10)

    at run (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:143:10)

    at PluginPass.ClassExpression (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-plugin-transform-es2015-classes/lib/index.js:48:60)

    at newFn (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-traverse/lib/visitors.js:276:21)

    at NodePath._call (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-traverse/lib/path/context.js:76:18)

    at NodePath.call (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-traverse/lib/path/context.js:48:17)

    at NodePath.visit (/home/travis/build/Project-OSRM/osrm-backend/node_modules/babel-traverse/lib/path/context.js:105:12)

SyntaxError: src/components/app.js: Missing class properties transform.

  43 | 

  44 | export default class App extends React.PureComponent {

> 45 |   static propTypes = {

     |   ^

  46 |     content: PropTypes.string.isRequired,

  47 |     ast: PropTypes.object.isRequired

  48 |   }

This looks like a silent dependency upgrade somewhere in the tree.

@daniel-j-h
Copy link
Member

Got resolved in #4041

@daniel-j-h
Copy link
Member

Reopening here. We're hitting the same issue again now on the 5.8 branch. Upgrading to 4.0.0-beta.18 does not help. This is blocking bumping http://project-osrm.org/docs/v5.7.0/api/ to 5.8.

@daniel-j-h daniel-j-h reopened this Jun 21, 2017
@daniel-j-h
Copy link
Member

👋 @tmcw any ideas on the documentation.js-internal error we're hitting here? I think @TheMarex or @danpat did the integration but I'm not sure if we're doing something wrong here. This looks like a React usage-issue to me.

@tmcw
Copy link

tmcw commented Jun 27, 2017

The linked line & the reported bug don't match: https://github.com/Project-OSRM/osrm-backend/blob/master/scripts/build_api_docs.sh#L17 is documenting a cpp file, the OP is produced by documenting a JavaScript file that I don't see referenced in this issue.

@tmcw
Copy link

tmcw commented Jun 27, 2017

Additionally, http://project-osrm.org/docs/v5.7.0/api/ is a docbox documentation site, not a documentation.js one. I think there are some wires crossed here.

@TheMarex
Copy link
Member Author

TheMarex commented Jun 27, 2017

Ah sorry I should have specified which documentation throws an error for me:

This is the code @danpat wrote to setup our docbox instance.

Currently I'm seeing the following error message locally:

SyntaxError: /home/patrick/Code/osrm-temp/build/docs/tmp/src/components/app.js: Missing class properties transform.
  43 | 
  44 | export default class App extends React.PureComponent {
> 45 |   static propTypes = {
     |   ^
  46 |     content: PropTypes.string.isRequired,
  47 |     ast: PropTypes.object.isRequired
  48 |   }
    at File.buildCodeFrameError (/home/patrick/Code/osrm-temp/node_modules/babel-core/lib/transformation/file/index.js:427:15)
    at NodePath.buildCodeFrameError (/home/patrick/Code/osrm-temp/node_modules/babel-traverse/lib/path/index.js:140:26)
    at pushBody (/home/patrick/Code/osrm-temp/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:262:20)
    at buildBody (/home/patrick/Code/osrm-temp/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:229:10)
    at run (/home/patrick/Code/osrm-temp/node_modules/babel-plugin-transform-es2015-classes/lib/vanilla.js:143:10)
    at PluginPass.ClassExpression (/home/patrick/Code/osrm-temp/node_modules/babel-plugin-transform-es2015-classes/lib/index.js:48:60)
    at newFn (/home/patrick/Code/osrm-temp/node_modules/babel-traverse/lib/visitors.js:276:21)
    at NodePath._call (/home/patrick/Code/osrm-temp/node_modules/babel-traverse/lib/path/context.js:76:18)
    at NodePath.call (/home/patrick/Code/osrm-temp/node_modules/babel-traverse/lib/path/context.js:48:17)
    at NodePath.visit (/home/patrick/Code/osrm-temp/node_modules/babel-traverse/lib/path/context.js:105:12)
SyntaxError: src/components/app.js: Missing class properties transform.
  43 | 
  44 | export default class App extends React.PureComponent {
> 45 |   static propTypes = {
     |   ^
  46 |     content: PropTypes.string.isRequired,
  47 |     ast: PropTypes.object.isRequired
  48 |   }

This can be reproduced by running yarn && yarn docs on master on node 4.7.1.

@tmcw
Copy link

tmcw commented Jun 27, 2017

Debugging custom build scripts is a bit outside of my domain here: docbox comes with scripts in its npm package that are guaranteed to work, and any other kind of setup is out of scope for the project. It looks like this custom setup isn't correctly using a .babelrc or installing the necessary transforms, as is indicated in the error message.

mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Jun 21, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Jun 21, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Jun 21, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Sep 4, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Sep 4, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Sep 4, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again and re-enables the check in CI.
mjjbell added a commit to mjjbell/osrm-backend that referenced this issue Dec 22, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again and re-enables the check in CI.
mjjbell added a commit that referenced this issue Dec 23, 2021
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in #4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again and re-enables the check in CI.
mattwigway pushed a commit to mattwigway/osrm-backend that referenced this issue Jul 20, 2023
NodeJS API docs are out of sync with NodeJS C++ wrapper documentation
due to the doc build breaking back in Project-OSRM#4043.

The commit fixes the Node dev dependencies such that `npm run docs`
works again and re-enables the check in CI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants