solidity-comments/index.js

`solidity-comments` is an N-API library built in Rust, which exposes a single function, which takes the contents of a Solidity source file and returns its comments.

const { existsSync, readFileSync } = require('fs')
const { join } = require('path')

const { platform, arch } = process

let nativeBinding = null
let localFileExisted = false
let loadError = null

function isMusl() {
  // For Node 10
  if (!process.report || typeof process.report.getReport !== 'function') {
    try {
      return readFileSync('/usr/bin/ldd', 'utf8').includes('musl')
    } catch (e) {
      return true
    }
  } else {
    const { glibcVersionRuntime } = process.report.getReport().header
    return !glibcVersionRuntime
  }
}

switch (platform) {
  case 'android':
    switch (arch) {
      case 'arm64':
        localFileExisted = existsSync(join(__dirname, 'solidity-comments.android-arm64.node'))
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.android-arm64.node')
          } else {
            nativeBinding = require('solidity-comments-android-arm64')
          }
        } catch (e) {
          loadError = e
        }
        break
      case 'arm':
        localFileExisted = existsSync(join(__dirname, 'solidity-comments.android-arm-eabi.node'))
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.android-arm-eabi.node')
          } else {
            nativeBinding = require('solidity-comments-android-arm-eabi')
          }
        } catch (e) {
          loadError = e
        }
        break
      default:
        throw new Error(`Unsupported architecture on Android ${arch}`)
    }
    break
  case 'win32':
    switch (arch) {
      case 'x64':
        localFileExisted = existsSync(
          join(__dirname, 'solidity-comments.win32-x64-msvc.node')
        )
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.win32-x64-msvc.node')
          } else {
            nativeBinding = require('solidity-comments-win32-x64-msvc')
          }
        } catch (e) {
          loadError = e
        }
        break
      case 'ia32':
        localFileExisted = existsSync(
          join(__dirname, 'solidity-comments.win32-ia32-msvc.node')
        )
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.win32-ia32-msvc.node')
          } else {
            nativeBinding = require('solidity-comments-win32-ia32-msvc')
          }
        } catch (e) {
          loadError = e
        }
        break
      case 'arm64':
        localFileExisted = existsSync(
          join(__dirname, 'solidity-comments.win32-arm64-msvc.node')
        )
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.win32-arm64-msvc.node')
          } else {
            nativeBinding = require('solidity-comments-win32-arm64-msvc')
          }
        } catch (e) {
          loadError = e
        }
        break
      default:
        throw new Error(`Unsupported architecture on Windows: ${arch}`)
    }
    break
  case 'darwin':
    switch (arch) {
      case 'x64':
        localFileExisted = existsSync(join(__dirname, 'solidity-comments.darwin-x64.node'))
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.darwin-x64.node')
          } else {
            nativeBinding = require('solidity-comments-darwin-x64')
          }
        } catch (e) {
          loadError = e
        }
        break
      case 'arm64':
        localFileExisted = existsSync(
          join(__dirname, 'solidity-comments.darwin-arm64.node')
        )
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.darwin-arm64.node')
          } else {
            nativeBinding = require('solidity-comments-darwin-arm64')
          }
        } catch (e) {
          loadError = e
        }
        break
      default:
        throw new Error(`Unsupported architecture on macOS: ${arch}`)
    }
    break
  case 'freebsd':
    if (arch !== 'x64') {
      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
    }
    localFileExisted = existsSync(join(__dirname, 'solidity-comments.freebsd-x64.node'))
    try {
      if (localFileExisted) {
        nativeBinding = require('./solidity-comments.freebsd-x64.node')
      } else {
        nativeBinding = require('solidity-comments-freebsd-x64')
      }
    } catch (e) {
      loadError = e
    }
    break
  case 'linux':
    switch (arch) {
      case 'x64':
        if (isMusl()) {
          localFileExisted = existsSync(
            join(__dirname, 'solidity-comments.linux-x64-musl.node')
          )
          try {
            if (localFileExisted) {
              nativeBinding = require('./solidity-comments.linux-x64-musl.node')
            } else {
              nativeBinding = require('solidity-comments-linux-x64-musl')
            }
          } catch (e) {
            loadError = e
          }
        } else {
          localFileExisted = existsSync(
            join(__dirname, 'solidity-comments.linux-x64-gnu.node')
          )
          try {
            if (localFileExisted) {
              nativeBinding = require('./solidity-comments.linux-x64-gnu.node')
            } else {
              nativeBinding = require('solidity-comments-linux-x64-gnu')
            }
          } catch (e) {
            loadError = e
          }
        }
        break
      case 'arm64':
        if (isMusl()) {
          localFileExisted = existsSync(
            join(__dirname, 'solidity-comments.linux-arm64-musl.node')
          )
          try {
            if (localFileExisted) {
              nativeBinding = require('./solidity-comments.linux-arm64-musl.node')
            } else {
              nativeBinding = require('solidity-comments-linux-arm64-musl')
            }
          } catch (e) {
            loadError = e
          }
        } else {
          localFileExisted = existsSync(
            join(__dirname, 'solidity-comments.linux-arm64-gnu.node')
          )
          try {
            if (localFileExisted) {
              nativeBinding = require('./solidity-comments.linux-arm64-gnu.node')
            } else {
              nativeBinding = require('solidity-comments-linux-arm64-gnu')
            }
          } catch (e) {
            loadError = e
          }
        }
        break
      case 'arm':
        localFileExisted = existsSync(
          join(__dirname, 'solidity-comments.linux-arm-gnueabihf.node')
        )
        try {
          if (localFileExisted) {
            nativeBinding = require('./solidity-comments.linux-arm-gnueabihf.node')
          } else {
            nativeBinding = require('solidity-comments-linux-arm-gnueabihf')
          }
        } catch (e) {
          loadError = e
        }
        break
      default:
        throw new Error(`Unsupported architecture on Linux: ${arch}`)
    }
    break
  default:
    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
}

if (!nativeBinding) {
  if (loadError) {
    throw loadError
  }
  throw new Error(`Failed to load native binding`)
}

const { analyze } = nativeBinding

module.exports.analyze = analyze