in process of refactoring - just a backup commit

.babelrc

@@ -0,0 +1,10 @@
+{
+    "presets": [
+        [
+            "@babel/preset-env",
+            {
+                "shippedProposals": true
+            }
+        ]
+    ]
+}

.eslintrc.js

@@ -1,37 +0,0 @@
-module.exports = {
-  "ecmaFeatures": {
-    "modules": true,
-    "spread" : true,
-    "restParams" : true
-  },
-  // "plugins": [
-  // "unicorn"
-  //  ],
-  "env": {
-    "es6": true,
-    "node": true,
-    "mocha": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2017,
-    "sourceType": "module"
-  },
-  "extends": "eslint:recommended",
-  "rules": {
-    "indent": [
-      "error",
-      2
-    ],
-    // "unicorn/no-array-instanceof": "error",
-    "no-console": 0,
-    "semi": ["error", "never"],
-    "linebreak-style": [
-      "error",
-      "unix"
-    ],
-    "quotes": [
-      "error",
-      "single"
-    ]
-  }
-}

.eslintrc.yml

@@ -0,0 +1,21 @@
+env:
+  node: true
+  es2021: true
+  mocha: true
+extends:
+  - standard
+parserOptions:
+  ecmaVersion: 12
+  sourceType: module
+rules:
+  indent:
+    - error
+    - 2
+  no-console: 0
+  semi:
+    - error
+    - never
+  quotes:
+    - error
+    - single
+parser: '@babel/eslint-parser'

bin/sync.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
-import Sync from '../src/sync'
+import Sync from '../src/sync.js'
 import to from 'await-to-js'
 // import logger from '@uci-utils/logger'
-import yargs from 'yargs'
+import Yargs from 'yargs'
 
 import readlines from '@uci-utils/read-lines'
 
 let jobname; let command
 console.log(process.argv)
-let args = yargs
+const args = Yargs(process.argv.slice(2))
   .boolean('w')
   .alias('w','watch')
   .boolean('v')
@@ -23,7 +23,7 @@ if (args._.length ===1) {
   jobname = args._[0]
   command = args._[1]
 }
-console.log(jobname, command)
+console.log('jobname',jobname, 'command',command)
 
 ;
 (async () => {

example/example.js

@@ -1,4 +1,4 @@
-import Sync from '../src/sync'
+import Sync from '../src/sync.js'
 import onDeath from  'ondeath'
 
 (async () => {
@@ -6,8 +6,8 @@ import onDeath from  'ondeath'
 
   await sync.runJob('remote')
   // await sync.loadJob('local')
-  // sync.watch('on')
+  sync.watch('on')
-  // console.log('ready and waiting')
+  console.log('ready and waiting')
 
   onDeath( () => {
     console.log('\nHe\'s dead Jim')

example/jobs/remote.yaml

@@ -1,23 +1,25 @@
-source: ./example/source/  # be sure to add trailing / to avoid making a subdirectory under destination
+# be sure to add trailing / to avoid making a subdirectory under destination
-destination: /opt/example
+source: ./example/source/
-flags: 'av'
+destination: example
+flags: "av"
 runOpts:
-    cli: true
+  cli: true
 excludeFrom:
-      - .gitignore
+  - .gitignore
-      - example/source/.npmignore
+  - example/source/.npmignore
 exclude:
-      - .gitignore
+  - .gitignore
-      - .npmignore
+  - .npmignore
 set:
   - delete
   - delete-excluded
   - stats
-watch:  # true
+watch: # true
   wait: 200
   immediate: true
 ssh:
-  host: relays.kebler.net
+  host: trantor.kebler.net
-  username: sysadmin
+  username: rbackup
+  privateKeyPath: /mnt/AllData/secure/privatekeys/xfer.kebler.net
   # quiet: true
   # additional: ''

nodemon.json

@@ -1,3 +1,21 @@
 {
-  "ext": "js, yaml"
+  "ignoreRoot": [
-}
+    ".git"
+  ],
+  "watch": [
+    "node_modules/@uci/",
+    "node_modules/@uci-utils/",
+    "readme/",
+    "src/",
+    "index.js",
+    "examples",
+    "test/",
+    "examples/"
+  ],
+  "ignore": [
+    "README.md",
+    "package*.json",
+    "test/files/"
+  ],
+  "ext": "js,json,yaml,yml,md"
+}

package.json

@@ -1,52 +1,59 @@
 {
-  "name": "@uci-utils/sync",
+	"main": "src/index.js",
-  "version": "0.0.10",
+	"type": "module",
-  "description": "module to copy, maintain, and launch hardware modules on other machines",
+	"scripts": {
-  "main": "src/index.js",
+		"test": "./node_modules/.bin/mocha --timeout 30000",
-  "bin": {
+		"sync": "node ./bin/sync",
-    "syncu": "./bin/sync-cli"
+		"example": "node ./example/example",
-  },
+		"testd": "UCI_ENV=dev ./node_modules/.bin/nodemon --exec 'npm run test'",
-  "scripts": {
+		"testdd": "UCI_LOG_LEVEL='trace' npm run testd",
-    "sync": "node -r esm ./bin/sync",
+		"testde": "UCI_LOG_LEVEL='warn' npm run testd",
-    "example": "node -r esm ./example/example",
+		"testl": "UCI_ENV=pro UCI_LOG_PATH=./test/test.log 0 npm run test || exit 0"
-    "test": "./node_modules/.bin/mocha -r esm --timeout 30000",
+	},
-    "testd": "UCI_ENV=dev ./node_modules/.bin/nodemon --exec './node_modules/.bin/mocha -r esm --timeout 30000'",
+	"author": "David Kebler",
-    "testdd": "UCI_LOG_LEVEL='trace' npm run testd",
+	"license": "MIT",
-    "testde": "UCI_LOG_LEVEL='warn' npm run testd",
+	"engines": {
-    "testl": "UCI_ENV=pro UCI_LOG_PATH=./test/test.log 0 npm run test || exit 0"
+		"node": ">=16.0.0"
-  },
+	},
-  "author": "David Kebler",
+	"devDependencies": {
-  "license": "MIT",
+		"chai": "^4.3.4",
-  "repository": {
+		"eslint": "^7.29.0",
-    "type": "git",
+		"eslint-config-standard": "^16.0.3",
-    "url": "git+https://github.com/uCOMmandIt/uci-remote-code.git"
+		"mocha": "^9.x",
-  },
+		"nodemon": "^2.0.12",
-  "keywords": [
+		"ondeath": "^1.0.0"
-    "node.js",
+	},
-    "I2C",
+	"keywords": [
-    "raspberryPi"
+		"node.js",
-  ],
+		"I2C",
-  "bugs": {
+		"raspberryPi"
-    "url": "https://github.com/uCOMmandIt/uci-remote-code/issues"
+	],
-  },
+	"name": "@uci-utils/sync",
-  "homepage": "https://github.com/uCOMmandIt/uci-remote-code#readme",
+	"version": "0.0.10",
-  "dependencies": {
+	"description": "module to copy, maintain, and launch hardware modules on other machines",
-    "@uci-utils/class-merge": "^1.0.3",
+	"bin": {
-    "@uci-utils/logger": "^0.0.16",
+		"syncu": "./bin/sync-cli"
-    "@uci-utils/read-lines": "^0.2.2",
+	},
-    "@uci-utils/watcher": "^0.2.4",
+	"repository": {
-    "await-to-js": "^2.1.1",
+		"type": "git",
-    "conf": "^5.0.0",
+		"url": "git+https://github.com/uCOMmandIt/uci-remote-code.git"
-    "debounce-fn": "^3.0.1",
+	},
-    "fs-read-data": "^1.0.4",
+	"bugs": {
-    "path-exists": "^4.0.0",
+		"url": "https://github.com/uCOMmandIt/uci-remote-code/issues"
-    "yargs": "^13.3.0"
+	},
-  },
+	"homepage": "https://github.com/uCOMmandIt/uci-remote-code#readme",
-  "devDependencies": {
+	"dependencies": {
-    "chai": "^4.2.0",
+		"@uci-utils/class-merge": "^1.1.0",
-    "esm": "^3.2.25",
+		"@uci-utils/logger": "^0.1.0",
-    "mocha": "^6.x",
+		"@uci-utils/read-lines": "^0.3.0",
-    "nodemon": "^1.19.1",
+		"@uci-utils/watcher": "^0.6.1",
-    "ondeath": "^1.0.0"
+		"await-to-js": "^3.0.0",
-  }
+		"conf": "^10.0.1",
+		"debounce-fn": "^5.0.0",
+		"js-yaml": "^3.14.1",
+		"load-yaml-file": "^0.2.0",
+		"path-exists": "^4.0.0",
+		"write-yaml-file": "^4.2.0",
+		"yargs": "^17.0.1"
+	}
 }

package.yml

@@ -0,0 +1,44 @@
+name: '@uci-utils/sync'
+version: 0.0.10
+description: module to copy, maintain, and launch hardware modules on other machines
+main: src/index.js
+bin:
+  syncu: ./bin/sync-cli
+type: module
+scripts:
+  sync: node ./bin/sync
+  example: node ./example/example
+  test: ./node_modules/.bin/mocha --timeout 30000
+  testd: UCI_ENV=dev ./node_modules/.bin/nodemon --exec 'npm run test'
+  testdd: UCI_LOG_LEVEL='trace' npm run testd
+  testde: UCI_LOG_LEVEL='warn' npm run testd
+  testl: UCI_ENV=pro UCI_LOG_PATH=./test/test.log 0 npm run test || exit 0
+author: David Kebler
+license: MIT
+repository:
+  type: git
+  url: git+https://github.com/uCOMmandIt/uci-remote-code.git
+keywords:
+  - node.js
+  - I2C
+  - raspberryPi
+bugs:
+  url: https://github.com/uCOMmandIt/uci-remote-code/issues
+homepage: https://github.com/uCOMmandIt/uci-remote-code#readme
+dependencies:
+  '@uci-utils/class-merge': ^1.1.0
+  '@uci-utils/logger': ^0.1.0
+  '@uci-utils/read-lines': ^0.3.0
+  '@uci-utils/watcher': ^0.6.1
+  await-to-js: ^3.0.0
+  conf: ^10.0.1
+  debounce-fn: ^5.0.0
+  load-yaml-file: ^0.2.0
+  path-exists: ^4.0.0
+  write-yaml-file: ^4.2.0
+  yargs: ^17.0.1
+devDependencies:
+  chai: ^4.3.4
+  mocha: ^9.x
+  nodemon: ^2.0.12
+  ondeath: ^1.0.0

readme.md

@@ -7,3 +7,32 @@
 [![Dependencies](https://img.shields.io/david/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template)
 [![devDependencies](https://img.shields.io/david/dev/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template?type=dev)
 [![codecov](https://img.shields.io/codecov/c/github/uCOMmandIt/uci-pkg-template/master.svg)](https://codecov.io/gh/uCOMmandIt/uci-pkg-template)
+
+
+# Why
+
+
+# Class API
+
+## public fields
+
+syncHandler
+jobsDir
+sshDir
+optionsDir
+
+
+
+## getters
+
+watching
+watcher
+getConfig
+
+## setters
+setConfig
+setJobsDir
+
+
+## public methods
+

src/index.js

@@ -1,5 +1,5 @@
-import Sync from  './sync'
+import Sync from  './sync.js'
-import Rsync from  './rsync'
+import Rsync from  './rsync.js'
 
 export { Sync, Rsync }
 export default Sync

src/rsync.js

@@ -1,5 +1,5 @@
-var spawn = require('child_process').spawn
+import { spawn } from'child_process'
-var path = require('path')
+import path from 'path'
 
 /**
  * Rsync is a wrapper class to configure and execute an `rsync` command
@@ -881,8 +881,9 @@ exposeShortOption('specials')
  */
 exposeShortOption('t', 'times')
 
-// our awesome export product
+
-module.exports = Rsync
+export default Rsync
+export { Rsync }
 
 /* **** */
 

src/sync.js

@@ -1,54 +1,79 @@
 // local imports
-import Rsync from './rsync'
+import Rsync from './rsync.js'
 // native imports
-import { EventEmitter as Emitter } from 'events'
+import { EventEmitter } from 'events'
 import { dirname, normalize } from 'path'
 // third party elements
 import merge from '@uci-utils/class-merge'
-import { readFile } from 'fs-read-data'
+import loadYaml from 'load-yaml-file'
 import Conf from 'conf'
 import debounce from 'debounce-fn'
 import pathExists from 'path-exists'
-import to from 'await-to-js'
+import { to } from 'await-to-js'
+import yaml from 'js-yaml'
 // uci imports
 import logger from '@uci-utils/logger'
 import Watcher from '@uci-utils/watcher'
 // import Watcher from '../../watcher/src/watcher'
 let log = {} // declare module wide log to be set during construction
 
-class Sync extends merge(Rsync, Emitter) {
+// class Sync extends merge(Rsync, Emitter) {
+class Sync extends EventEmitter {
+
+  #config
+  // #debounce 
+  #watcher
+  #cwd
+  #settings
+  #sources
+  #excludeFiles
+  #exclude
+
+  
   constructor(opts = {}) {
     super()
     log = logger({ package:'@uci/sync'})
-    this.opts = opts
+    this.#settings = Object.assign({},opts)  // need deep clone?
-    this._debounce = opts.debounce || null
+    // this.#debounce = opts.debounce || null
-    this.syncHandler = opts.syncHandler ? opts.syncHandler.bind(this) : defaultSyncHandler.bind(this)
+    this.#settings.syncHandler = opts.syncHandler ? opts.syncHandler.bind(this) : defaultSyncHandler.bind(this)
     // TODO if opts include source and destination then call loadJob with them
-    this.config = new Conf({projectName:'sync'})
+    console.log('settings',this.#settings)
-    this.jobsDir = process.env.SYNC_JOBS_DIR  || opts.jobsDir || this.config.get('jobsDir') || dirname(this.config.path)
+    this.#config = new Conf(
-    this.sshDir = opts.sshDir || this.config.get('sshDir') || `${this.jobsDir}/ssh`
+      {
-    this.optionsDir = opts.optionsDir || this.config.get('optionsDir') || `${this.jobsDir}/options`
+       configName:this.#settings.configName, 
+       cwd:this.#settings.configDir,
+       	fileExtension: 'yaml',
+	serialize: yaml.safeDump,
+	deserialize: yaml.safeLoad
+      }
+       )
+    this.#config.set('test',"a test")
+    console.dir(this.#config.store)
+    this.#settings.jobsDir = process.env.SYNC_JOBS_DIR  || this.#settings.jobsDir || this.#config.get('jobsDir') || dirname(this.#config.path)
+    this.#settings.sshDir = opts.sshDir || this.#config.get('sshDir') || `${this.jobsDir}/ssh`
+    this.#settings.optionsDir = this.#settings.optionsDir || this.#config.get('optionsDir') || `${this.jobsDir}/options`
     log.debug({jobsDir:this.jobsDir, sshDir:this.sshDir, optionsDir:this.optionsDir, msg:'configuration file directories'})
-    this._watcher = new Watcher()
+    this.#watcher = new Watcher()
   }
   // getters and setters
-  get watching() {return this._watcher.watching } // watcher active?
-  get watcher() { return this._watcher}  // in case one need set a listerner for other purposes
 
-  get defaultJobsDir() { return this.config.get('jobsDir', this.jobsDir) }
+  get watching() {return this.#watcher.watching } // watcher active?
+  get watcher() { return this.#watcher}  // in case one need set a listerner for other purposes
+
+  get defaultJobsDir() { return this.#config.get('jobsDir', this.jobsDir) }
   set defaultJobsDir(jobsDir) {
-    if (jobsDir==null) this.config.delete('jobsDir')
+    if (jobsDir==null) this.#config.delete('jobsDir')
-    else this.config.set('jobsDir', jobsDir)
+    else this.#config.set('jobsDir', jobsDir)
   }
 
-  setConfig(name,val) { this.config.set(name,val)}
+  setConfig(name,val) { this.#config.set(name,val)}
-  getConfig(name) { return this.config.get(name)}
+  getConfig(name) { return this.#config.get(name)}
 
   async setJobsDir(dir='',save) {
     let res = await pathExists(dir)
     if(res){
-      this.jobsDir=dir
+      this.#settings.jobsDir=dir
-      if(save) this.setDefaultJobsDir()
+      if(save) this.setDefaultJobsDir(dir)
       return res
     }
     else {
@@ -57,16 +82,23 @@ class Sync extends merge(Rsync, Emitter) {
     }
   }
 
-  // job and options processing
+  // internal private methods
 
-  async runJob(options) {
+  async #readOptionsFile(filePath,type='job') {
-    let res = await this.loadJob(options)
+    let dir = {job:this.jobsDir,options:this.optionsDir,ssh:this.sshDir}
-    this.live()
+    let [err,res] = await to(readFile(`${dir[type]}/${filePath}`))
-    await this.execute(this.opts)
+    if (err) {
+      [err,res] = await to(readFile(filePath))
+      if (err) {
+        err = {filePath:normalize(`${this.#cwd}/${dir[type]}/${filePath}`), error:err, type:type, msg:`unable to read ${filePath} options file`}
+        log.warn(err)
+        return err
+      }
+    }
     return res
   }
 
-  async loadJob (options) {
+  async #loadJob (options) {
     if (typeof options ==='string') options = await this.readOptionsFile(options,'job')
     if (!options.error) {
       for (const option in options) {
@@ -83,30 +115,26 @@ class Sync extends merge(Rsync, Emitter) {
         }
       } // end loop
       this.dry()  // dry run by default must .live() .unset('n')
-      let success = {options:options, cwd:this._cwd, command:this.command(), msg: 'job options processed sucessfully'}
+      let success = {options:options, cwd:this.#cwd, command:this.command(), msg: 'job options processed sucessfully'}
       log.info(success)
       return success
     } throw options  // options is error
   }
 
 
+  async runJob(options) {
+    let res = await this.loadJob(options)
+    this.live()
+    await this.execute(this.opts)
+    return res
+  }
+
+
   // async listJobFiles(dir) {
   //   return await getFiles(['**','*.yaml','*.yml'],{ onlyfiles:true, cwd:dir || this.jobsDir})
   // }
 
-  async readOptionsFile(filePath,type='job') {
+
-    let dir = {job:this.jobsDir,options:this.optionsDir,ssh:this.sshDir}
-    let [err,res] = await to(readFile(`${dir[type]}/${filePath}`))
-    if (err) {
-      [err,res] = await to(readFile(filePath))
-      if (err) {
-        err = {filePath:normalize(`${this._cwd}/${dir[type]}/${filePath}`), error:err, type:type, msg:`unable to read ${filePath} options file`}
-        log.warn(err)
-        return err
-      }
-    }
-    return res
-  }
 
   // executes a method on the instance (might be in prototype chain) which may take a value(s)
   async processOption (method, value)  {
@@ -141,48 +169,48 @@ class Sync extends merge(Rsync, Emitter) {
   async watch(cmd) {
     // TODO make into switch ?
     log.debug(`watch command ${cmd}`)
-    let opts = {source:this._sources, excludeFrom:this._excludeFiles, ignored:this._exclude }
+    let opts = {source:this.#sources, excludeFrom:this.#excludeFiles, ignored:this.#exclude }
 
     if (isPlainObject(cmd) || cmd==null || (typeof cmd==='boolean' && cmd) || cmd==='init'  || cmd==='add') {
-      if (cmd.wait) this.debounce(cmd)
+      // if (cmd.wait) this.debounce(cmd)
-      if ( cmd.init || cmd==='init') await this._watcher.init(opts)
+      if ( cmd.init || cmd==='init') await this.#watcher.init(opts)
       return this
     }
 
     if (cmd==='remove') {
-      this._watcher.removeListener('changed', this.syncHandler )
+      this.#watcher.removeListener('changed', this.syncHandler )
-      this._watcher.remove()
+      this.#watcher.remove()
       return
     }
 
     if (cmd ==='on'|| cmd==='start') {
-      this._watcher.on('changed', this.syncHandler)
+      this.#watcher.on('changed', this.syncHandler)
-      this._watcher.start(opts)
+      this.#watcher.start(opts)
       return
     }
 
     if (cmd==='off' || cmd==='stop' ) {
-      this._watcher.removeListener('changed', this.syncHandler)
+      this.#watcher.removeListener('changed', this.syncHandler)
-      this._watcher.stop()
+      this.#watcher.stop()
       return
     }
 
     if (cmd==='pause' ) {
-      this._watcher.removeListener('changed', this.syncHandler)
+      this.#watcher.removeListener('changed', this.syncHandler)
       return
     }
 
     if (cmd==='resume') {
-      this._watcher.on('changed', this.syncHandler)
+      this.#watcher.on('changed', this.syncHandler)
       return
     }
   }
 
-  debounce(opts) {
+  // set debounce(opts) {
-    if (opts==null) this._debounce=null
+  //   if (opts==null) this.#debounce=null
-    this._debounce = opts
+  //   this.#debounce = opts
-    return this
+  //   return this
-  }
+  // }
 
   sshu (file) {
     if (file && (typeof options==='string')) {
@@ -259,8 +287,8 @@ export default Sync
 // default handler 'changed' event handler with optional debounce wrapper
 function defaultSyncHandler(change={}) {
   log.debug({file:change.file, type:change.type, msg:`file ${change.file} was ${change.type}`})
-  if (this._debounce==null) this.execute(this.opts)
+  // if (this.#debounce==null) this.execute(this.opts)
-  else debounce(this.execute.bind(this),this._debounce)(this.opts)
+  // else debounce(this.execute.bind(this),this.#debounce)(this.opts)
 }
 
 function isPlainObject (obj) {

test/files/jobs/local.yaml

@@ -0,0 +1,13 @@
+source: ./test/files/source
+destination: ./test/files/destination
+flags: "av"
+excludeFrom:
+      - ./test/files/source/.gitignore
+      - ./test/files/source/.npmignore
+exclude:
+      - .gitignore
+      - .npmignore
+set:
+      - delete
+      - delete-excluded
+watch: true

test/jobs/local.yaml

@@ -1,13 +0,0 @@
-source: ./test/repo
-destination: ./test/dest
-flags: 'av'
-excludeFrom:
-      - ./test/repo/.gitignore
-      - ./test/repo/.npmignore
-exclude:
-      - .gitignore
-      - .npmignore
-set:
-  - delete
-  - delete-excluded
-watch:

test/sync.test.js

@@ -1,20 +1,22 @@
-import Sync from '../src/sync'
+import Sync from '../src/sync.js'
 import to from 'await-to-js'
 import { expect } from 'chai'
-import { it } from 'mocha'
+import { it, describe } from 'mocha'
-import logger from '@uci-utils/logger'
-// pause = require('@uci/utils').pPause
 
-describe('Sync Class Testing ',async ()=> {
+before(async () => {
-
+    console.log('in before')
-  let log = logger({})
+    const opts = {
-  before(async () => {
+      configDir:'./test/files',
-    // log = logger({ package:'@uci/sync', id: 'sync-test' })
+      configName:'sync_config'
-    let sync = new Sync({jobsDir:'./test/jobs'})
+    }
-    await sync.loadJob('remote')
+    let sync = new Sync(opts)
-    console.log('command to be run',sync.command())
+  
-    sync.live()
+    console.log(sync.getConfig)
-    sync.execute({cli:true})
+ 
+    // await sync.loadJob('remote')
+    // console.log('command to be run',sync.command())
+    // sync.live()
+    // sync.execute({cli:true})
 
     // await sync.configure('./test/config/sync')
     // log.info({cmd:sync.command(), msg:'Rsync Command that will Run'})
@@ -22,6 +24,9 @@ describe('Sync Class Testing ',async ()=> {
     // log.info('ready for testing')
   })
 
+describe('Sync Class Testing ',async ()=> {
+
+  // let log = logger({})
   // after(async () => {
   //   remote.close()
   // })