ssh-config 4.1.3 → 4.1.6

package/Readme.md

@@ -108,12 +108,14 @@ config.find({ Host: 'example1' })
 config.find(line => line.param == 'Host' && line.value == 'example1')
 ```
 
-### `.remove` sections by Host or other criteria
+### `.remove` sections by Host / Match or function
 
 To remove sections, we can pass the section to `.remove(opts)`.
 
 ```js
 config.remove({ Host: 'example1' })
+// or the ES2015 Array.prototype.find
+config.remove(line => line.param == 'Host' && line.value == 'example1')
 ```
 
 ### `.append` sections
@@ -121,7 +123,7 @@ config.remove({ Host: 'example1' })
 Since the parsed config is a sub class of Array, you can append new sections with methods like `.push` or `.concat`.
 
 ```js
-config.push(SSHConfig.parse(`
+config.push(...SSHConfig.parse(`
 Host ness
   HostName lochness.com
   User dinosaur

package/index.js

@@ -79,7 +79,7 @@ class SSHConfig extends Array {
   }
 
   /**
-   * find section by Host or Match
+   * find section by Host / Match or function
    */
   find(opts = {}) {
     if (typeof opts === 'function') return super.find(opts)
@@ -92,17 +92,22 @@ class SSHConfig extends Array {
   }
 
   /**
-   * Remove section
+   * Remove section by Host / Match or function
    */
   remove(opts = {}) {
-    if (!(opts && ('Host' in opts || 'Match' in opts))) {
-      throw new Error('Can only remove by Host or Match')
-    }
+    let index;
+
+    if (typeof opts === 'function') {
+      index = super.findIndex(opts);
 
-    const index = typeof opts === 'function'
-      ? super.findIndex(opts)
-      : super.findIndex(line => compare(line, opts))
+    } else if (!(opts && ('Host' in opts || 'Match' in opts))) {
+      throw new Error('Can only remove by Host or Match');
 
+    } else {
+      index = super.findIndex(line => compare(line, opts));
+
+    } 
+    
     if (index >= 0) return this.splice(index, 1)
   }
 
@@ -457,6 +462,10 @@ class SSHConfig extends Array {
         config.push(node)
         config = node.config = new SSHConfig()
       }
+      else if (node.type === DIRECTIVE && !node.param) {
+        // blank lines at file end
+        config[config.length - 1].after += node.before
+      }
       else {
         config.push(node)
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-config",
   "description": "SSH config parser and stringifier",
-  "version": "4.1.3",
+  "version": "4.1.6",
   "author": "Chen Yangjian (https://www.cyj.me)",
   "repository": {
     "type": "git",
@@ -13,15 +13,19 @@
     "types"
   ],
   "devDependencies": {
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.23",
     "eslint": "^7.17.0",
     "heredoc": "^1.3.1",
     "mocha": "^8.2.1",
-    "nyc": "^15.1.0"
+    "nyc": "^15.1.0",
+    "typescript": "^4.6.3"
   },
   "scripts": {
     "lint": "eslint .",
-    "test": "mocha --exit",
-    "test:coverage": "nyc mocha --exit && nyc report --reporter=lcov"
+    "pretest": "tsc",
+    "test": "NODE_OPTIONS=--enable-source-maps mocha --exit --recursive",
+    "test:coverage": "nyc mocha --exit --recursive && nyc report --reporter=lcov"
   },
   "engine": {
     "node": ">= 10.0.0"

package/types/index.d.ts

@@ -13,7 +13,7 @@ interface Directive {
 }
 
 interface Section extends Directive {
-  config: SSHConfig;
+  config: SSHConfig<Line>;
 }
 
 interface Comment {
@@ -21,21 +21,26 @@ interface Comment {
   content: string;
 }
 
-type Line = Directive | Comment;
+type Line = Section | Directive | Comment;
 
-export default class SSHConfig extends Array {
-  static parse(text: string): SSHConfig;
-  static stringify(config: SSHConfig): string;
+declare class SSHConfig<T> extends Array<T> {
+  static parse(text: string): SSHConfig<Line>;
+  static stringify(config: SSHConfig<Line>): string;
+
+  static DIRECTIVE: ELine.DIRECTIVE;
+  static COMMENT: ELine.COMMENT;
 
   toString(): string;
 
   compute(host: string): Record<string, string>;
 
-  find(predicate: (value: any, index: number, obj: any[]) => any);
+  find<T>(this: SSHConfig<T>, predicate: (line: T, index: number, config: T[]) => boolean): T;
   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;
+  append(options: Record<string, string>): SSHConfig<Line>;
+  prepend(options: Record<string, string>): SSHConfig<Line>;
 }
+
+export default class extends SSHConfig<Line> {}

package/History.md

@@ -1,187 +0,0 @@
-4.1.3 / 2022-03-11
-==================
-
-## What's Changed
-* fix: IdentityAgent should be quoted if necessary by @cyjake in https://github.com/cyjake/ssh-config/pull/52
-
-
-**Full Changelog**: https://github.com/cyjake/ssh-config/compare/v4.1.2...v4.1.3
-
-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
-==================
-
- * fix: should not quote directives like LocalForward (#38)
-
-
-4.0.3 / 2020-08-24
-==================
-
- * fix: quote values that contain white spaces (36)
-
-
-4.0.2 / 2020-02-09
-==================
-
- * fix: 'compute' fails when hosts contain regex chars #34 @roblourens
-
-
-4.0.1 / 2020-02-01
-==================
-
- * Fix: parsing `Host` values with trailing spaces
-
-
-4.0.0 / 2020-01-09
-==================
-
- * Fix: allow forwarding directives (and `CertificateFile`) to have multiple values (#30)
-
-
-3.0.1 / 2020-01-07
-==================
-
- * Fix: append new section to empty config (#27)
-
-
-3.0.0 / 2019-12-12
-==================
-
- * Breaking: prefer to separate sections with `\n\n` (#23, #24)
- * Breaking: drop `SSHConfig.find()`, please use `SSHConfig.prototype.find()` instead
-
-
-2.0.0 / 2019-10-08
-==================
-
- * Breaking: parse `Host` values as an Array to hold multiple patterns
- * Breaking: an extra line break will always be added when `.append()`ing config
- * Fix: `Host` can contain spaces if quoted with double quotes
- * Fix: quoted values can contain double quotes once they are escaped with backslash
- * Fix: escape + when converting patterns to regexp
- * Fix: parameter/value pairs separated with tab charactor
-
-
-1.1.6 / 2019-04-02
-==================
-
- * Fix: appending to empty config
-
-
-1.1.5 / 2018-12-06
-==================
-
- * Fix: auto insert newline when `.append()`ing existing config without trailing newlines. #15
-
-
-1.1.3 / 2017-09-25
-==================
-
- * Fix: appended config shall comply with existing style, otherwhise default to two spaces. Also an extra linebreak is added after the last line.
-
-
-1.1.2 / 2017-09-22
-==================
-
- * Fix: nagate patterns shall be matched first and fail early
-
-
-1.1.1 / 2017-09-13
-==================
-
- * Fix: values of `IdentityFile` will now be quoted if contain space.
- * Fix: quoted values will have their double quotations stripped while parsed, which is a slightly breaking behavior but I think a patch version will just be fine.
-
-
-1.1.0 / 2017-09-07
-==================
-
- * New: `config.append({ Host: '*' })`
-
-Allow appending sections via `config.append({ ... })` method. Closes #12.
-
-
-1.0.1 / 2017-02-06
-==================
-
- * Fix: trim spaces at value beginning and endding
- * Fix: make example east more compact
-
-
-1.0.0 / 2016-05-05
-==================
-
- * Fix: updated readme to be reflect 1.x changes
- * Breaking: parse into a simple ast
-
-This is a breaking change. The parse result is now a subclass of Array instead of vanila Object.
-
-
-0.2.1 / 2015-11-17
-==================
-
- * Fix: code style and one more test case
- * Merge pull request #7 from petemill/fix-leading-newline
- * Only add a newline between sections if there are previous lines. Fixes https://github.com/dotnil/ssh-config/issues/6
-
-
-0.2.0 / 2015-07-07
-==================
-
- * Added converage with istanbul
- * Added .append, .find, and .remove; fixes #4
- * Added documentations about said methods
- * Added badges about npm downloads, version, and build status
- * Added .travis.yml
- * Implemented .query and support pattern matching (poorly)
-
-
-0.1.0 / 2015-01-12
-==================
-
- * Init repo
- * Implemented `.parse` and `.stringify`
-

package/types/ssh-config-tests.ts

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