@1inch/solidity-utils 4.1.0 → 4.2.0

package/utils/README.md

@@ -5,18 +5,18 @@
 Generates documentation in markdown format from natspec docs
 
 ##### Usage
-Add to `package.json` file solidity compiler version (add version you use), solidity-docgen (0.5, 0.6 is unstable) util and shortcut to run command
+Add to `package.json` file solidity compiler version (add version you use), solidity-docgen 0.6 util and shortcut to run command
 
 `devDependencies` section
 
 ```
 "solc": "0.8.23",
-"solidity-docgen": "0.5.17",
+"solidity-docgen": "0.6.0-beta.36",
 ```
 
 `scripts` section
 ```
-"docify": "npx solidity-utils-docify"
+"docify": "yarn hardhat docgen; npx solidity-utils-docify"
 ```
 
 You can set output directory with ENV variable:
@@ -24,7 +24,25 @@ You can set output directory with ENV variable:
 "docify": "DOCGEN_OUTPUT_DIR=./docs npx solidity-utils-docify"
 ```
 
+Then set appopriate settings for docgen in `hardhat.config.js` file
+
+```JavaScript
+require('solidity-docgen');
+
+// You can use 1inch templates built-in templates
+const { oneInchTemplates } = require('@1inch/solidity-utils/docgen');
+
+module.exports = {
 ...
+    docgen: {
+        outputDir: "docs", // Can be omitted, docs used by default
+        templates: oneInchTemplates(), // 1inch templates
+        pages: 'files', // Doc output format for 1inch templates
+        exclude: ['mocks', 'test'], // Directories to exclude from generation
+    }
+}
+
+```
 
 #### Dependencies list (imports-list)
 

package/utils/docify.utils.js

@@ -1,27 +1,14 @@
 #!/usr/bin/env node
-const SOLC_NPM_NAME = 'solc';
 const BASE_DIR = 'docs';
-const SCRIPT_DIR = __dirname;
-const INPUT_DIR = 'contracts';
-const OUTPUT_DIR = process.env.DOCGEN_OUTPUT_DIR || `${BASE_DIR}/contracts`;
-const HELPERS_PATH = `${SCRIPT_DIR}/solidity-docgen-helpers.js`;
+const OUTPUT_DIR = process.env.DOCGEN_OUTPUT_DIR || `${BASE_DIR}`;
 
 const fs = require('fs');
 const path = require('path');
-const spawn = require('cross-spawn');
 
 function getFileNameWithoutExtension (fileName) {
     return fileName.substr(0, fileName.lastIndexOf('.'));
 }
 
-function runProcess (name, args) {
-    console.log(`running ${name} with args ${JSON.stringify(args)}`);
-    const result = spawn.sync(name, args, { stdio: ['inherit', 'inherit', 'pipe'] });
-    if (result.stderr.length > 0) {
-        throw new Error(result.stderr);
-    }
-}
-
 function getReadmes (targetPath) {
     let result = [];
     const readmePath = path.join(targetPath, 'README.md');
@@ -108,23 +95,5 @@ function removeUnwantedDocs () {
     }
 }
 
-const solidityDocgenArgs = [
-    'solidity-docgen',
-    '-i',
-    INPUT_DIR,
-    '-o',
-    OUTPUT_DIR,
-    '--solc-module',
-    SOLC_NPM_NAME,
-    '--solc-settings',
-    JSON.stringify({ optimizer: { enabled: false } }),
-    '--templates',
-    SCRIPT_DIR,
-    '--helpers',
-    HELPERS_PATH,
-];
-
-fs.rmSync(OUTPUT_DIR, { force: true, recursive: true });
-runProcess('npx', solidityDocgenArgs);
 generateGitbookFiles();
 removeUnwantedDocs();

package/utils/contract.hbs

@@ -1,69 +0,0 @@
-# {{{name}}}
-
-
-{{{natspec.title}}}
-{{{natspec.userdoc}}}
-{{{natspec.devdoc}}}
-
-{{#if (withoutFirstElement inheritance)}}
-## Derives
-{{/if}}
-{{#each (withoutFirstElement inheritance)}}
-{{#if (getRelativeDocPath name source.contractsDir source.solcOutput.sources)}}
-- [{{name}}]({{getRelativeDocPath name source.contractsDir source.solcOutput.sources}})
-{{else}}
-- {{name}}
-{{/if}}
-{{/each}}
-
-{{#if ownFunctions}}
-## Functions
-{{/if}}
-{{#ownFunctions}}
-### {{name}}
-```solidity
-function {{name}}(
-  {{#args}}
-  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
-  {{/args}}
-) {{visibility}}{{#if outputs}} returns ({{outputs}}){{/if}}
-```
-{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
-{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
-{{#if args}}
-#### Parameters:
-| Name | Type | Description                                                          |
-| :--- | :--- | :------------------------------------------------------------------- |
-{{#args}}
-|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
-{{/args}}{{/if}}
-{{#if natspec.returns}}
-#### Return Values:
-| Name                           | Type          | Description                                                                  |
-| :----------------------------- | :------------ | :--------------------------------------------------------------------------- |
-{{#natspec.returns}}
-|`{{param}}`| {{#lookup ../outputs.types @index}}{{/lookup}} | {{{removeNewlines description}}}
-{{/natspec.returns}}{{/if}}
-{{/ownFunctions}}
-{{#if ownEvents}}
-## Events
-{{/if}}
-{{#ownEvents}}
-### {{name}}
-```solidity
-event {{name}}(
-  {{#args}}
-  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
-  {{/args}}
-)
-```
-{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
-{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
-{{#if args}}
-#### Parameters:
-| Name | Type | Description                                                          |
-| :--- | :--- | :------------------------------------------------------------------- |
-{{#args}}
-|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
-{{/args}}{{/if}}
-{{/ownEvents}}