ssh-config 4.0.5 → 4.1.2

package/History.md

@@ -1,8 +1,47 @@
+4.1.2 / 2022-01-20
+==================
+
+## What's Changed
+* docs: types field in package.json by @cyjake in https://github.com/cyjake/ssh-config/pull/50
+
+
+**Full Changelog**: https://github.com/cyjake/ssh-config/compare/v4.1.1...v4.1.2
+
+4.1.1 / 2021-10-21
+==================
+
+## What's Changed
+* docs: `.prepend` and type definitions by @cyjake in https://github.com/cyjake/ssh-config/pull/47
+* fix: improper parsing of ProxyCommand with quotation marks by @tanhakabir in https://github.com/cyjake/ssh-config/pull/48
+
+
+**Full Changelog**: https://github.com/cyjake/ssh-config/compare/v4.1.0...v4.1.1
+
+4.1.0 / 2021-10-20
+==================
+
+## What's Changed
+* test: switching to github actions by @cyjake in https://github.com/cyjake/ssh-config/pull/44
+* feat: add prepend function to prepend options onto config by @tanhakabir in https://github.com/cyjake/ssh-config/pull/45
+* build: switch to codecov by @cyjake in https://github.com/cyjake/ssh-config/pull/46
+
+## New Contributors
+* @tanhakabir made her first contribution in https://github.com/cyjake/ssh-config/pull/45
+
+**Full Changelog**: https://github.com/cyjake/ssh-config/compare/v4.0.6...v4.1.0
+
+4.0.6 / 2021-05-11
+==================
+
+ * fix: IdentityFile parameter value should be quoted if contains space
+
+
 4.0.5 / 2021-01-08
 ==================
 
  * fix: multiple LocalForward values should be formartted into multiple lines
 
+
 4.0.4 / 2020-09-01
 ==================
 

package/Readme.md

@@ -3,7 +3,8 @@
 [![NPM Downloads](https://img.shields.io/npm/dm/ssh-config.svg?style=flat)](https://www.npmjs.com/package/ssh-config)
 [![NPM Version](http://img.shields.io/npm/v/ssh-config.svg?style=flat)](https://www.npmjs.com/package/ssh-config)
 [![Build Status](https://travis-ci.org/cyjake/ssh-config.svg)](https://travis-ci.org/cyjake/ssh-config)
-[![Coverage Status](https://coveralls.io/repos/github/cyjake/ssh-config/badge.svg?branch=master)](https://coveralls.io/github/cyjake/ssh-config?branch=master)
+[![Node CI](https://github.com/cyjake/ssh-config/actions/workflows/nodejs.yml/badge.svg)](https://github.com/cyjake/ssh-config/actions/workflows/nodejs.yml)
+[![codecov](https://codecov.io/gh/cyjake/ssh-config/branch/master/graph/badge.svg?token=RMyTgcL8Kg)](https://codecov.io/gh/cyjake/ssh-config)
 
 ## Usage
 
@@ -153,6 +154,62 @@ SSHConfig.stringify(config)
 //   User dinosaur
 ```
 
+### `.prepend` sections
+
+But appending options to the end of the config isn't very effective if your config is organizated per the recommendations of ssh_config(5) that the generic options are at at the end of the config, such as:
+
+```
+Host ness
+  HostName lochness.com
+  User dinosaur
+
+IdentityFile ~/.ssh/id_rsa
+```
+
+The config could get messy if you put new options after the line of `IdentityFile`. To work around this issue, it is recommended that `.prepend` should be used instead. For the example above, we can prepend new options at the beginning of the config:
+
+```js
+config.prepend({
+  Host: 'tahoe',
+  HostName 'tahoe.com',
+})
+```
+
+The result would be:
+
+```
+Host tahoe
+  HostName tahoe.com
+
+Host ness
+  HostName lochness.com
+  User dinosaur
+
+IdentityFile ~/.ssh/id_rsa
+```
+
+If there are generic options at the beginning of the config, and you'd like the prepended section put before the first existing section, please turn on the second argument of `.prepend`:
+
+```js
+config.prepend({
+  Host: 'tahoe',
+  HostName 'tahoe.com',
+}, true)
+```
+
+The result would be like:
+
+```
+IdentityFile ~/.ssh/id_rsa
+
+Host tahoe
+  HostName tahoe.com
+
+Host ness
+  HostName lochness.com
+  User dinosaur
+```
+
 ## References
 
 - [ssh_config(5)][ssh_config]

package/index.js

@@ -5,16 +5,13 @@ const glob = require('./src/glob')
 const RE_SPACE = /\s/
 const RE_LINE_BREAK = /\r|\n/
 const RE_SECTION_DIRECTIVE = /^(Host|Match)$/i
-const RE_MULTI_VALUE_DIRECTIVE = /^(GlobalKnownHostsFile|Host|IPQoS|SendEnv|UserKnownHostsFile)$/i
-const RE_QUOTE_DIRECTIVE = /^(?:CertificateFile|IdentifyFile|User)$/i
+const RE_MULTI_VALUE_DIRECTIVE = /^(GlobalKnownHostsFile|Host|IPQoS|SendEnv|UserKnownHostsFile|ProxyCommand)$/i
+const RE_QUOTE_DIRECTIVE = /^(?:CertificateFile|IdentityFile|User)$/i
+const RE_SINGLE_LINE_DIRECTIVE = /^(Include|IdentityFile)$/i
 
 const DIRECTIVE = 1
 const COMMENT = 2
 
-function compare(line, opts) {
-  return opts.hasOwnProperty(line.param) && opts[line.param] === line.value
-}
-
 const MULTIPLE_VALUE_PROPS = [
   'IdentityFile',
   'LocalForward',
@@ -23,6 +20,24 @@ const MULTIPLE_VALUE_PROPS = [
   'CertificateFile'
 ]
 
+function compare(line, opts) {
+  return opts.hasOwnProperty(line.param) && opts[line.param] === line.value
+}
+
+function getIndent(config) {
+  for (const line of config) {
+    if (RE_SECTION_DIRECTIVE.test(line.param)) {
+      for (const subline of line.config) {
+        if (subline.before) {
+          return subline.before
+        }
+      }
+    }
+  }
+
+  return '  '
+}
+
 class SSHConfig extends Array {
   /**
    * Query ssh config by host.
@@ -105,20 +120,7 @@ class SSHConfig extends Array {
    * @param {Object} opts
    */
   append(opts) {
-    let indent = '  '
-
-    outer:
-    for (const line of this) {
-      if (RE_SECTION_DIRECTIVE.test(line.param)) {
-        for (const subline of line.config) {
-          if (subline.before) {
-            indent = subline.before
-            break outer
-          }
-        }
-      }
-    }
-
+    const indent = getIndent(this)
     const lastEntry = this.length > 0 ? this[this.length - 1] : null
     let config = lastEntry && lastEntry.config || this
     let configWas = this
@@ -153,6 +155,71 @@ class SSHConfig extends Array {
     return configWas
   }
 
+  /**
+   * Prepend new section to existing ssh config.
+   * @param {Object} opts
+   */
+  prepend(opts, beforeFirstSection = false) {
+    const indent = getIndent(this)
+    let config = this
+    let i = 0
+
+    // insert above known sections
+    if (beforeFirstSection) {
+      while (i < this.length && !RE_SECTION_DIRECTIVE.test(this[i].param)) {
+        i += 1
+      }
+
+      if (i >= this.length) { // No sections in original config
+        return this.append(opts)
+      }
+    }
+
+    // Prepend new section above the first section
+    let sectionLineFound = false
+    let processedLines = 0
+
+    for (const param in opts) {
+      processedLines += 1
+      const line = {
+        type: DIRECTIVE,
+        param,
+        separator: ' ',
+        value: opts[param],
+        before: '',
+        after: '\n'
+      }
+
+      if (RE_SECTION_DIRECTIVE.test(param)) {
+        config.splice(i, 0, line)
+        config = line.config = new SSHConfig()
+        sectionLineFound = true
+        continue
+      }
+
+      // separate from previous sections with an extra newline
+      if (processedLines === Object.keys(opts).length) {
+        line.after += '\n'
+      }
+
+      if (!sectionLineFound) {
+        config.splice(i, 0, line)
+        i += 1
+
+        // Add an extra newline if a single line directive like Include
+        if (RE_SINGLE_LINE_DIRECTIVE.test(param)) {
+          line.after += '\n'
+        }
+        continue
+      }
+
+      line.before = indent
+      config.push(line)
+    }
+
+    return config
+  }
+
   /**
    * Stringify structured object into ssh config text
    * @param {SSHConfig} config

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-config",
   "description": "SSH config parser and stringifier",
-  "version": "4.0.5",
+  "version": "4.1.2",
   "author": "Chen Yangjian (https://www.cyj.me)",
   "repository": {
     "type": "git",
@@ -9,7 +9,8 @@
   },
   "files": [
     "index.js",
-    "src"
+    "src",
+    "types"
   ],
   "devDependencies": {
     "eslint": "^7.17.0",
@@ -20,10 +21,11 @@
   "scripts": {
     "lint": "eslint .",
     "test": "mocha --exit",
-    "coveralls": "nyc mocha --exit && nyc report --reporter=text-lcov | coveralls"
+    "test:coverage": "nyc mocha --exit && nyc report --reporter=lcov"
   },
   "engine": {
-    "node": ">= 6.0.0"
+    "node": ">= 10.0.0"
   },
+  "types": "types/index.d.ts",
   "license": "MIT"
 }

package/types/index.d.ts

@@ -0,0 +1,41 @@
+declare enum ELine {
+  DIRECTIVE = 1,
+  COMMENT = 2,
+}
+
+interface Directive {
+  type: ELine.DIRECTIVE;
+  before: string;
+  after: string;
+  param: string;
+  separator: ' ' | '=';
+  value: string;
+}
+
+interface Section extends Directive {
+  config: SSHConfig;
+}
+
+interface Comment {
+  type: ELine.COMMENT;
+  content: string;
+}
+
+type Line = Directive | Comment;
+
+export default class SSHConfig extends Array {
+  static parse(text: string): SSHConfig;
+  static stringify(config: SSHConfig): string;
+
+  toString(): string;
+
+  compute(host: string): Record<string, string>;
+
+  find(predicate: (value: any, index: number, obj: any[]) => any);
+  find(options: Record<string, string>): Line | Section;
+
+  remove(options: Record<string, string>): Line | Section;
+
+  append(options: Record<string, string>): SSHConfig;
+  prepend(options: Record<string, string>): SSHConfig;
+}

package/types/ssh-config-tests.ts

@@ -0,0 +1,10 @@
+import SSHConfig from './index';
+
+const config = SSHConfig.parse(`
+IdentityFile ~/.ssh/id_rsa
+
+Host ness
+  HostName lochness.com
+`);
+
+console.log(config.toString());