Initial commit

voxpelli · voxpelli · commit b1504b2c3340 · 2022-12-13T18:13:18.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+/coverage/**/*
+*.d.ts
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,34 @@
+{
+  "root": true,
+  "plugins": [
+    "jsdoc",
+    "unicorn"
+  ],
+  "extends": [
+    "@socketsecurity",
+    "plugin:jsdoc/recommended"
+  ],
+  "settings": {
+    "jsdoc": {
+      "mode": "typescript"
+    }
+  },
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "@typescript-eslint/quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": false }],
+    "no-console": "warn",
+
+    "jsdoc/check-types": "off",
+    "jsdoc/no-undefined-types": "off",
+    "jsdoc/require-jsdoc": "warn",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-property-description": "off",
+    "jsdoc/require-returns-description": "off",
+    "jsdoc/require-yields": "off",
+    "jsdoc/valid-types": "off",
+
+    "unicorn/expiring-todo-comments": "warn"
+  }
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,26 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  linting:
+    name: "Linting"
+    uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
+    with:
+      no-lockfile: true
+      npm-test-script: 'check'
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -0,0 +1,30 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: "Tests"
+    uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
+    with:
+      no-lockfile: true
+      npm-test-script: 'test-ci'
+      node-versions: '14,16,18,19'
+      # We currently have some issues on Windows that will have to wait to be fixed
+      # os: 'ubuntu-latest,windows-latest'
+      os: 'ubuntu-latest'
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,19 @@
+# Basic ones
+/coverage
+/coverage-ts
+/node_modules
+/.env
+/.nyc_output
+/.vscode
+
+# We're a library, so please, no lock files
+/package-lock.json
+/yarn.lock
+
+# Generated types
+*.d.ts
+*.d.ts.map
+!/lib/types/**/*.d.ts
+
+# Library specific ones
+!/.vscode/extensions.json
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Socket Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,64 @@
+# Socket Config
+
+[![npm version](https://img.shields.io/npm/v/@socketsecurity/config.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/config)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/SocketDev/eslint-config)
+[![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)
+[![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
+
+Reader/parser/validator tool for [Socket.dev](https://socket.dev/)'s [`socket.yml`](https://docs.socket.dev/docs/socket-yml) configuration files
+
+## Usage
+
+```bash
+npm install @socketsecurity/config
+```
+
+```javascript
+import { readSocketConfig } from '@socketsecurity/config'
+
+const config = await readSocketConfig('socket.yml')
+```
+
+## Exports
+
+### `readSocketConfig(<path-to-config-file>)`
+
+Returns a `Promise` that resolves to the parsed config file or, if no such file was found, it fails silently and returns `undefined`.
+
+If the config file can't be read, then the `Promise` will be rejected with an error.
+
+The read file is parsed using `parseSocketConfig`and the `Promise` from there is what is ultimately returned when no rejection or resolve has been made already.
+
+### `parseSocketConfig(<content-of-config-file>)`
+
+Returns a `Promise` that resolves to the parsed config.
+
+If the config content can't be parsed or it is invalid, then the `Promise` will be rejected with an error.
+
+Any additional parameters that does not conform to the schema will be silently dropped. Also: Input data will be coerced into its intended shape when possible.
+
+### `socketYmlSchema`
+
+A JSON Schema object typed with [`JSONSchemaType<SocketYml>`](https://ajv.js.org/guide/typescript.html) from Ajv
+
+### `SocketValidationError`
+
+Error thrown when the parsed data doesn't conform to the JSON Schema definition (see `socketYmlSchema`).
+
+Exposes an array of [Ajv's `ErrorObject`](https://ajv.js.org/api.html#error-objects) at `.validationErrors`, allowing a consumer to present a user friendly error.
+
+## Type exports
+
+This module has full type coverage through a [types in js](https://github.com/voxpelli/types-in-js) where TypeScript validates JSDoc annotated javascript and exports it as standard type definition files.
+
+### `SocketYml`
+
+A TypeScript type representing the shape of the parsed `socket.yml` config
+
+## Used by
+
+* [`@socketsecurity/cli`](https://github.com/SocketDev/socket-cli-js) - our CLI uses this to parse the Socket config
+
+## See also
+
+* [Socket.yml reference](https://docs.socket.dev/docs/socket-yml) - the config parsed by this module
diff --git a/declaration.tsconfig.json b/declaration.tsconfig.json
@@ -0,0 +1,14 @@
+
+{
+  "extends": "./tsconfig",
+  "exclude": [
+    "test/**/*.js"
+  ],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "removeComments": true
+  }
+}
diff --git a/index.js b/index.js
@@ -0,0 +1,143 @@
+'use strict'
+
+const { readFile } = require('node:fs/promises')
+
+const { default: Ajv } = require('ajv')
+const { ErrorWithCause } = require('pony-cause')
+const { parse: yamlParse } = require('yaml')
+
+/**
+ * @typedef SocketYmlGitHub
+ * @property {boolean} [beta] beta opt in field
+ * @property {boolean} [enabled] enable/disable the Socket.dev GitHub app entirely
+ * @property {boolean} [projectReportsEnabled] enable/disable Github app project report checks
+ * @property {boolean} [pullRequestAlertsEnabled] enable/disable GitHub app pull request alert checks
+ */
+
+/**
+ * @typedef SocketYml
+ * @property {2} version
+ * @property {string[]} [projectIgnorePaths]
+ * @property {{ [issueName: string]: boolean }} [issueRules]
+ * @property {SocketYmlGitHub} [githubApp]
+ */
+
+/** @type {import('ajv').JSONSchemaType<SocketYml>} */
+const socketYmlSchema = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  properties: {
+    version: { type: 'integer' },
+    projectIgnorePaths: {
+      type: 'array',
+      items: { type: 'string' },
+      nullable: true,
+    },
+    issueRules: {
+      type: 'object',
+      nullable: true,
+      required: [],
+      additionalProperties: { type: 'boolean' },
+    },
+    githubApp: {
+      type: 'object',
+      nullable: true,
+      properties: {
+        beta: { type: 'boolean', nullable: true },
+        enabled: { type: 'boolean', nullable: true },
+        projectReportsEnabled: { type: 'boolean', nullable: true },
+        pullRequestAlertsEnabled: { type: 'boolean', nullable: true },
+      },
+      required: [],
+      additionalProperties: false,
+    },
+  },
+  required: ['version'],
+  additionalProperties: false,
+}
+
+const ajv = new Ajv({
+  allErrors: true,
+  coerceTypes: 'array',
+  logger: false,
+  removeAdditional: 'failing',
+})
+
+const validate = ajv.compile(socketYmlSchema)
+
+/**
+ * @param {string} filePath
+ * @returns {Promise<SocketYml|undefined>}
+ * @throws {SocketValidationError}
+ */
+async function readSocketConfig (filePath) {
+  /** @type {string} */
+  let fileContent
+
+  try {
+    fileContent = await readFile(filePath, 'utf8')
+  } catch (err) {
+    if (isErrnoException(err) && err.code === 'ENOENT') {
+      return
+    }
+    throw new ErrorWithCause('Error when reading socket.yml config file', { cause: err })
+  }
+
+  return parseSocketConfig(fileContent)
+}
+
+/**
+ * @param {string} fileContent
+ * @returns {Promise<SocketYml>}
+ * @throws {SocketValidationError}
+ */
+async function parseSocketConfig (fileContent) {
+  /** @type {unknown} */
+  let parsedContent
+
+  try {
+    parsedContent = yamlParse(fileContent)
+  } catch (err) {
+    throw new ErrorWithCause('Error when parsing socket.yml config', { cause: err })
+  }
+
+  if (!validate(parsedContent)) {
+    throw new SocketValidationError('Invalid config definition', validate.errors || [])
+  }
+
+  return parsedContent
+}
+
+/**
+ * @param {unknown} value
+ * @returns {value is NodeJS.ErrnoException}
+ */
+function isErrnoException (value) {
+  if (!(value instanceof Error)) {
+    return false
+  }
+
+  const errnoException = /** @type NodeJS.ErrnoException} */ (value)
+
+  return errnoException.code !== undefined
+}
+
+class SocketValidationError extends Error {
+  /**
+   * @param {string} message
+   * @param {import('ajv').ErrorObject[]} validationErrors
+   */
+  constructor (message, validationErrors) {
+    super(message)
+
+    /** @type {import('ajv').ErrorObject[]} */
+    this.validationErrors = validationErrors
+  }
+}
+
+module.exports = {
+  parseSocketConfig,
+  readSocketConfig,
+  SocketValidationError,
+  socketYmlSchema,
+}
diff --git a/package.json b/package.json
diff --git a/test/.eslintrc b/test/.eslintrc
diff --git a/test/parse.spec.js b/test/parse.spec.js
diff --git a/test/read.spec.js b/test/read.spec.js
diff --git a/test/sample.yml b/test/sample.yml
diff --git a/tsconfig.json b/tsconfig.json
