Solidity-docgen gives Syntax Error: Unexpected token 'export'

br4e · November 10, 2020, 9:20pm

(prompt)> yarn run solidity-docgen --solc-module <point to solc version 0.7.4 binary>
SyntaxError: Unexpected token ‘export’

Environment

node v 12.18.3, repros on node 9, 10, 11, 12, 13, 14, 15
“solidity-docgen”: “^0.5.7”,
contracts/ folder with several contracts with “pragma solidity =0.7.4;”
macos 10.15.7

Details

Looking around at this error generally it has to do with node not supporting ES6 syntax (“export”) and using babel to transpile is a solution, but this seems overly complex, there must be something else going on

Code to reproduce

frangio · November 10, 2020, 9:33pm

Yes this should just work. What are you putting in as argument to --solc-module?

br4e · November 10, 2020, 9:40pm

sudo yarn run solidity-docgen  --solc-module /Users/br4e/Documents/GitHub/solc-select/bin/solc

(prompt)> /Users/br4e/Documents/GitHub/solc-select/bin/solc --version
solc, the solidity compiler commandline interface
Version: 0.7.4+commit.3f05b770.Linux.g++

frangio · November 16, 2020, 5:26am

You’re not supposed to use a solc binary, it should be a path to a JavaScript solc module installed from npm. Take a look at the example in the changelog for version 0.5.6.

github.com

OpenZeppelin/solidity-docgen/blob/63a052daa52247eab693f4a0d287c43608532d9f/CHANGELOG.md#056

# Changelog

## 0.5.7

- Fixed a bug that caused `solidity-docgen` to fail with solc >=0.7.1.

## 0.5.6

- Fixed a bug that prevented using solc 0.7 with the `--solc-module` option.

The built in compiler remains solc 0.6, but users who want to use the newer
compiler version can do so by installing the desired solc version and using the
flag `--solc-module`. Here's an example using npm aliases:

```
npm install -D solc-0.7@npm:solc@^0.7.0
npx solidity-docgen --solc-module solc-0.7
```

## 0.5.5

This file has been truncated. show original

br4e · November 10, 2020, 9:38pm

This is working in my clean test repo, now going to try to get to work in my main repo.

--solc-module=solc-module path to an alternative solc module
^^ this is what --help gives, maybe this could be explained in more depth for future people tripping over it

abcoathup · November 10, 2020, 10:44pm

Hi @br4e,

I have created a PR to add Solidity 0.7 instructions to the README: https://github.com/OpenZeppelin/solidity-docgen/pull/252