Remove multiple SPDX-License-Identifiers

index.js

@@ -12,6 +12,8 @@ const mkdirp = require("mkdirp");
 const Resolver = require("@resolver-engine/imports-fs").ImportsFsEngine;
 
 const IMPORT_SOLIDITY_REGEX = /^\s*import(\s+)[\s\S]*?;\s*$/gm;
+const SPDX_FULL_LICENSE_IDENTIFIER_REGEX = /^\s*\/\/ SPDX-License-Identifier:(\s+)[\s\S]*?\s*$/gm;
+const SPDX_LICENSE_IDENTIFIER_REGEX = /SPDX-License/gm;
 
 function unique(array) {
   return [...new Set(array)];
@@ -115,9 +117,10 @@ async function getSortedFilePaths(entryPoints, projectRoot) {
   return files;
 }
 
-async function fileContentWithoutImports(filePath) {
+async function fileContentWithoutImportsAndConcatLicenses(filePath) {
   const resolved = await resolve(filePath);
-  const output = resolved.fileContents.replace(IMPORT_SOLIDITY_REGEX, "");
+  let output = resolved.fileContents.replace(IMPORT_SOLIDITY_REGEX, "");
+  output = output.replace(SPDX_LICENSE_IDENTIFIER_REGEX, "AND License");
 
   // normalize whitespace to a single trailing newline
   return output.trim() + "\n";
@@ -134,17 +137,26 @@ function fileNameToGlobalName(fileName, projectRoot) {
   return globalName;
 }
 
+async function getSPDXLicense(files) {
+  return (await resolve(files.pop())).fileContents.match(SPDX_FULL_LICENSE_IDENTIFIER_REGEX);
+}
+
 async function printContactenation(files, log) {
   const parts = await Promise.all(
     files.map(async file => {
       return (
-        "// File: " + file + "\n\n" + (await fileContentWithoutImports(file))
+        "// File: " + file + "\n\n" + (await fileContentWithoutImportsAndConcatLicenses(file))
       );
     })
   );
 
-  // add a single empty line between parts
-  log(parts.join("\n"));
+  // get license and add a single empty line between parts
+  const license = await getSPDXLicense(files);
+  if (license) {
+    log(license.concat(parts).join("\n"));
+  } else {
+    log(parts.join("\n"));
+  }
 }
 
 async function getProjectRoot() {

tests/contracts/child.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 pragma solidity >=0.4.24 <0.8.0;
 
 import "./parent.sol";

tests/contracts/cycle1.sol

@@ -1 +1,2 @@
+// SPDX-License-Identifier: MIT
 import "./cycle2.sol";

tests/contracts/cycle2.sol

@@ -1 +1,2 @@
+// SPDX-License-Identifier: MIT
 import "./cycle1.sol";

tests/contracts/parent.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.5.2;
 
 import "openzeppelin-solidity/contracts/access/Roles.sol";

tests/tests.js

@@ -20,7 +20,6 @@ describe("flattening", function() {
     const files = getFilesInFlattenedOrder(
       await flatten(["./contracts/child.sol"])
     );
-
     assert.include(files, "contracts/parent.sol");
   });
 
@@ -135,4 +134,18 @@ describe("flattening", function() {
 
     assert.equal(content, expected);
   });
+
+  it("Should concatenate multiple SPDX licenses", async function() {
+    const flattened = await flatten([
+      "./contracts/child.sol",
+      "./contracts/child.sol",
+      "./contracts/parent.sol"
+    ]);
+
+    const LICENSE_IDENTIFIER_REGEX = /^\s*\/\/ SPDX-License-Identifier:(\s+)[\s\S]*?\s*$/gm;
+    const licenses = flattened.match(LICENSE_IDENTIFIER_REGEX);
+
+    assert.equal(licenses.length, 1);
+    assert.include(flattened, "// AND License-Identifier: MIT");
+  });
 });

tests/truffle-config.js

@@ -0,0 +1,141 @@
+/**
+ * Use this file to configure your truffle project. It's seeded with some
+ * common settings for different networks and features like migrations,
+ * compilation, and testing. Uncomment the ones you need or modify
+ * them to suit your project as necessary.
+ *
+ * More information about configuration can be found at:
+ *
+ * https://trufflesuite.com/docs/truffle/reference/configuration
+ *
+ * Hands-off deployment with Infura
+ * --------------------------------
+ *
+ * Do you have a complex application that requires lots of transactions to deploy?
+ * Use this approach to make deployment a breeze 🏖️:
+ *
+ * Infura deployment needs a wallet provider (like @truffle/hdwallet-provider)
+ * to sign transactions before they're sent to a remote public node.
+ * Infura accounts are available for free at 🔍: https://infura.io/register
+ *
+ * You'll need a mnemonic - the twelve word phrase the wallet uses to generate
+ * public/private key pairs. You can store your secrets 🤐 in a .env file.
+ * In your project root, run `$ npm install dotenv`.
+ * Create .env (which should be .gitignored) and declare your MNEMONIC
+ * and Infura PROJECT_ID variables inside.
+ * For example, your .env file will have the following structure:
+ *
+ * MNEMONIC = <Your 12 phrase mnemonic>
+ * PROJECT_ID = <Your Infura project id>
+ *
+ * Deployment with Truffle Dashboard (Recommended for best security practice)
+ * --------------------------------------------------------------------------
+ *
+ * Are you concerned about security and minimizing rekt status 🤔?
+ * Use this method for best security:
+ *
+ * Truffle Dashboard lets you review transactions in detail, and leverages
+ * MetaMask for signing, so there's no need to copy-paste your mnemonic.
+ * More details can be found at 🔎:
+ *
+ * https://trufflesuite.com/docs/truffle/getting-started/using-the-truffle-dashboard/
+ */
+
+// require('dotenv').config();
+// const { MNEMONIC, PROJECT_ID } = process.env;
+
+// const HDWalletProvider = require('@truffle/hdwallet-provider');
+
+module.exports = {
+  /**
+   * Networks define how you connect to your ethereum client and let you set the
+   * defaults web3 uses to send transactions. If you don't specify one truffle
+   * will spin up a managed Ganache instance for you on port 9545 when you
+   * run `develop` or `test`. You can ask a truffle command to use a specific
+   * network from the command line, e.g
+   *
+   * $ truffle test --network <network-name>
+   */
+
+  networks: {
+    // Useful for testing. The `development` name is special - truffle uses it by default
+    // if it's defined here and no other network is specified at the command line.
+    // You should run a client (like ganache, geth, or parity) in a separate terminal
+    // tab if you use this network and you must also set the `host`, `port` and `network_id`
+    // options below to some value.
+    //
+    // development: {
+    //  host: "127.0.0.1",     // Localhost (default: none)
+    //  port: 8545,            // Standard Ethereum port (default: none)
+    //  network_id: "*",       // Any network (default: none)
+    // },
+    //
+    // An additional network, but with some advanced options…
+    // advanced: {
+    //   port: 8777,             // Custom port
+    //   network_id: 1342,       // Custom network
+    //   gas: 8500000,           // Gas sent with each transaction (default: ~6700000)
+    //   gasPrice: 20000000000,  // 20 gwei (in wei) (default: 100 gwei)
+    //   from: <address>,        // Account to send transactions from (default: accounts[0])
+    //   websocket: true         // Enable EventEmitter interface for web3 (default: false)
+    // },
+    //
+    // Useful for deploying to a public network.
+    // Note: It's important to wrap the provider as a function to ensure truffle uses a new provider every time.
+    // goerli: {
+    //   provider: () => new HDWalletProvider(MNEMONIC, `https://goerli.infura.io/v3/${PROJECT_ID}`),
+    //   network_id: 5,       // Goerli's id
+    //   confirmations: 2,    // # of confirmations to wait between deployments. (default: 0)
+    //   timeoutBlocks: 200,  // # of blocks before a deployment times out  (minimum/default: 50)
+    //   skipDryRun: true     // Skip dry run before migrations? (default: false for public nets )
+    // },
+    //
+    // Useful for private networks
+    // private: {
+    //   provider: () => new HDWalletProvider(MNEMONIC, `https://network.io`),
+    //   network_id: 2111,   // This network is yours, in the cloud.
+    //   production: true    // Treats this network as if it was a public net. (default: false)
+    // }
+  },
+
+  // Set default mocha options here, use special reporters, etc.
+  mocha: {
+    // timeout: 100000
+  },
+
+  // Configure your compilers
+  compilers: {
+    solc: {
+      version: "0.8.17" // Fetch exact version from solc-bin (default: truffle's version)
+      // docker: true,        // Use "0.5.1" you've installed locally with docker (default: false)
+      // settings: {          // See the solidity docs for advice about optimization and evmVersion
+      //  optimizer: {
+      //    enabled: false,
+      //    runs: 200
+      //  },
+      //  evmVersion: "byzantium"
+      // }
+    }
+  }
+
+  // Truffle DB is currently disabled by default; to enable it, change enabled:
+  // false to enabled: true. The default storage location can also be
+  // overridden by specifying the adapter settings, as shown in the commented code below.
+  //
+  // NOTE: It is not possible to migrate your contracts to truffle DB and you should
+  // make a backup of your artifacts to a safe location before enabling this feature.
+  //
+  // After you backed up your artifacts you can utilize db by running migrate as follows:
+  // $ truffle migrate --reset --compile-all
+  //
+  // db: {
+  //   enabled: false,
+  //   host: "127.0.0.1",
+  //   adapter: {
+  //     name: "indexeddb",
+  //     settings: {
+  //       directory: ".db"
+  //     }
+  //   }
+  // }
+};