DigixGlobal / doxity

📑 Documentation Generator for Solidity
BSD 3-Clause "New" or "Revised" License
212 stars 59 forks source link

Doxity init creates scripts folder but nothing else #9

Closed elmutt closed 7 years ago

elmutt commented 7 years ago

Running "doxity init" creates an empty scripts folder and nothing else.

IstoraMandiri commented 7 years ago

Hi There,

Thanks for the report. What's your OS and doxity version?

Cheers,

elmutt commented 7 years ago

Hi Chris,

OSX El Capitan. Doxity v0.3.2

Thanks,

Sean

On Tue, Dec 20, 2016 at 1:46 PM, Chris Hitchcott notifications@github.com wrote:

Hi There,

Thanks for the report. What's your OS and doxity version?

Cheers,

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/DigixGlobal/doxity/issues/9#issuecomment-268354970, or mute the thread https://github.com/notifications/unsubscribe-auth/AF5qJ5qZteEh7LDHQU3rW44ktn7xwmTRks5rKD6ggaJpZM4LSRKq .

cag commented 7 years ago

I got this error as well. This is the response in the console for me. I am running Arch Linux 64-bit Doxity v0.3.2 Node 7.1.0.

$ doxity init
.doxityrc not found or unreadable
Getting "https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/37f63a26c2664c31f4463a49af939ddb6e2181e7.tar.gz...
(node:7760) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 2): Error: Invalid URI "%22https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/37f63a26c2664c31f4463a49af939ddb6e2181e7.tar.gz"
(node:7760) DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Here is a workaround:

doxity init --source https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/37f63a26c2664c31f4463a49af939ddb6e2181e7.tar.gz
IstoraMandiri commented 7 years ago

Thanks for the and finding a workaround @cag.

I'm putting doxity on a temporary hold for the moment, as it depends on the native compiler, which doesn't work with truffle imports. I will address this issue once that upgrade is completed.

yudilevi commented 7 years ago

Is the project still on hold?

tymat commented 7 years ago

What version of solidity are you using? @yudilevi

yudilevi commented 7 years ago

Latest, 0.4.11 @tymat

tymat commented 7 years ago

Do you have doxity 0.5.0?

Also what is in your .doxityrc file?

yudilevi commented 7 years ago

I just installed doxity, latest version (globally). I didn't use any .doxityrc file - which as I understand uses the defaults. I also tried using the file but doxity can't find it - I assume because I'm on a windows machine and process.env.PWD is undefined. I tried to define PWD manually but still no go.

tymat commented 7 years ago

What version of nodejs do you have on your machine?

yudilevi commented 7 years ago

node v7.9.0.

And correction about .doxityrc - after setting up process.env.PWD, doxity init seems to find the file, but still stuck in Getting https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/9445d59056058159ce25d7cd1643039523718553.tar.gz...

Btw I'm also available on gitter.

And thanks!

tymat commented 7 years ago
{
  "target": "scripts/doxity",
  "src": "contracts/*",
  "dir": "pages/docs",
  "source": "https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/a4886b7a7a04c018ac04fed3125d7d4785e74bed.tar.gz",
  "out": "docs"
}

You can try the following .doxityrc

yudilevi commented 7 years ago

Same result - scripts folder is created, stuck at Getting https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/9445d59056058159ce25d7cd1643039523718553.tar.gz...

Edit: scripts folder is created empty

yudilevi commented 7 years ago

One possible explanation would be that this - .pipe(targz().createWriteStream(tmpTarget))

Doesn't actually create the entire directory tree, but only creates a single directory and then fails, but haven't debugged it yet.

IstoraMandiri commented 7 years ago

Doxity is not on hold and should be working with truffle projects. This will be added as a low-priority TODO for now as unfortunately we're not using windows. Do feel free to submit PRs if you'd like to add windows support more quickly.

The OP's issue should now be fixed in latest. @yudilevi It looks like your problems are due to windows, so i am closing this issue and windows issue to #14