imdone-core 1.45.0 → 1.46.0

package/lib/adapters/file-gateway.js

@@ -30,6 +30,11 @@ module.exports = {
     return fs.readFileSync.apply({}, args)
   },
 
+  appendFileSync(...args) {
+    console.warn('sync call')
+    return fs.appendFileSync.apply({}, args)
+  },
+
   writeFileSync(...args) {
     console.warn('sync call')
     return fs.writeFileSync.apply({}, args)
@@ -78,6 +83,7 @@ module.exports = {
     console.warn('sync call')
     return fs.readdirSync(path, { withFileTypes: true })
   },
+  
   sanitizeFileName(fileName, replaceSpacesWith) {
     // Remove markdown emoji
     fileName = fileName.replace(/:\w+:/g, '').trim()
@@ -85,5 +91,21 @@ module.exports = {
     if (replaceSpacesWith)
       fileName = fileName.replace(/ /g, replaceSpacesWith)
     return fileName
+  },
+
+  preparePathForWriting(path) {
+    let stat = this.statSync(path)
+    if (!stat) {
+      let { dir, ext } = _path.parse(path)
+      if (!ext) {
+        dir = path
+      }
+      this.mkdirpSync(dir)
+      stat = this.statSync(path)
+    }
+    return {
+      isFile: stat && stat.isFile(),
+      isDirectory: stat && stat.isDirectory()
+    }
   }
 }

package/lib/card.js

@@ -327,7 +327,9 @@ module.exports = function newCard(task, _project, dontParse) {
       )
       const formattedRawMarkdown = this.formatContent(rawMarkdown, true).content
       const { html, truncHtml } = this.getHtml(content)
+      const title = this.format(this.text, true)
       return {
+        title,
         html,
         truncHtml,
         encodedText,

package/lib/config.js

@@ -179,6 +179,18 @@ class Config {
     return _get(this, 'settings.cards.maxLines', 1)
   }
 
+  get archiveFolder() {
+    return _get(this, 'settings.cards.archiveFolder', '')
+  }
+
+  get archiveCompleted() {
+    return _get(this, 'settings.cards.archiveCompleted', false)
+  }
+
+  get doneList() {
+    return this.getDoneList()
+  }
+
   get blankLinesToEndTask() {
     let blankLinesToEndTask = Math.round(
       _get(this, 'settings.cards.blankLinesToEndTask', 1)

package/lib/file.js

@@ -74,6 +74,7 @@ function File(opts) {
     this.tasks = []
     this.isDir = false
     this.lineCount = 0
+    this.deleted = false
   }
 }
 util.inherits(File, events.EventEmitter)

package/lib/migrate-config.js

@@ -36,6 +36,9 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
         config.code.include_lists.push(list.name)
       })
 
+      if (!config.settings.cards) {
+        config.settings.cards = {}
+      }
       // metaSep
       if (config.settings.metaSep) {
         config.settings.cards.metaSep = config.settings.metaSep
@@ -47,14 +50,20 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
         delete config.settings.defaultList
       }
 
-      if (!config.settings.cards) {
-        config.settings.cards = {}
-      }
-
       if (!config.settings.cards.defaultList) {
         config.settings.cards.defaultList = lists ? lists[0] : ''
       }
 
+      // archiveCompleted
+      if (config.settings.cards.archiveCompleted === undefined) {
+        config.settings.cards.archiveCompleted = false
+      }
+
+      // archiveFolder
+      if (!config.settings.cards.archiveFolder) {
+        config.settings.cards.archiveFolder = config.settings.journalPath ? _path.join(config.settings.journalPath, 'archive') : 'archive'
+      }
+
       // showTagsAndMeta
       if (config.settings.cards.showTagsAndMeta === undefined) {
         config.settings.cards.showTagsAndMeta = true
@@ -126,7 +135,12 @@ module.exports = function (repo, defaultSettings = defaultSettingsObject) {
       // make sure all lists have an id
       config.lists.forEach((list) => {
         if (!list.id || (list.id + "").length < 4) list.id = uniqid()
-      })      
+      })
+
+      // Make sure kudosProbability is set
+      if (!config.settings.kudosProbability && config.settings.kudosProbability !== 0) {
+        config.settings.kudosProbability = 0.33
+      }
 
       const defaultCardsSettings = _cloneDeep(defaultSettings.cards)
       const cardsSettings = _cloneDeep(config.settings.cards)

package/lib/mixins/repo-fs-store.js

@@ -311,7 +311,8 @@ function mixin(repo, fs = require('fs')) {
     cb = tools.cb(cb)
 
     if (!File.isFile(file)) return cb(new Error(ERRORS.NOT_A_FILE))
-
+    if (file.deleted) return cb(null, file)
+    
     var filePath = repo.getFullPath(file)
 
     if (!/\.\.(\/|\\)/.test(file.path)) {

package/lib/plugins/archive-plugin.js

@@ -0,0 +1,58 @@
+const Plugin = require('imdone-api')
+const path = require('path')
+
+module.exports = class ArchivePlugin extends Plugin {
+  constructor(project) {
+    super(project)
+  }
+
+  get config() {
+    return this.project.config
+  }
+
+  get fileGateway() {
+    return this.project.fileGateway
+  }
+
+  onBeforeBoardUpdate() {
+    const config = this.config
+    if (!config || !config.archiveCompleted || this.archivingTasks) return
+    this.archivingTasks = true
+    const cards = this.project.getAllCards(`meta.archived != "true" and list = ${config.doneList}`)
+    const messageUser = cards.length > 1
+    if (!cards.length) {
+      this.archivingTasks = false
+      return
+    } else {
+      if (messageUser) this.project.snackBar({message: `Archiving ${cards.length} card(s)...`})
+    }
+    cards.forEach(card => this.archiveTask(card))
+    if (messageUser) this.project.snackBar({message: ` Done archiving ${cards.length} card(s). Deleting original(s)...`})
+    this.project.deleteTasks(cards).then(() => {
+      this.archivingTasks = false
+      if (messageUser) this.project.snackBar({message: `Done deleting original card(s).`})
+    })
+  }
+
+  archiveTask (task, config = this.config) {
+    const archiveFolder = config.archiveFolder
+    const fileDir = path.dirname(task.relPath)
+    
+    if (fileDir.startsWith(archiveFolder)) return
+
+    const fileName = this.fileGateway.sanitizeFileName(`${task.text}.md`, config.replaceSpacesWith)
+    const newPath = path.join(this.project.path, archiveFolder, fileDir, fileName)
+    
+    const content = this.project.addMetaToContent(
+      [
+        { key: 'archived', value: 'true'}
+      ], 
+      task.content
+    )
+    const taskContent = `${task.beforeText}#${task.list} ${content}`
+
+    this.fileGateway.preparePathForWriting(newPath)
+    this.fileGateway.appendFileSync(newPath, taskContent)
+  }
+
+}

package/lib/plugins/plugin-manager.js

@@ -11,7 +11,11 @@ module.exports = class PluginManager extends Emitter {
   constructor(project) {
     super()
     this.project = project
-    this.defaultPlugins = ['./epic-plugin', './extension-plugin', './cli-backlog-plugin']
+    this.defaultPlugins = [
+      './archive-plugin',
+      './epic-plugin', 
+      './extension-plugin'
+    ]
     this.pluginsMap = {}
     this.pluginPath = _path.join(project.path, '.imdone', 'plugins')
     this.onDevChange = debounce(this.onDevChange.bind(this), 1000)
@@ -19,7 +23,7 @@ module.exports = class PluginManager extends Emitter {
   }
 
   async startDevMode() {
-    if (this.project.config.devMode && !this.watcher) {
+    if (this.project && this.project.config.devMode && !this.watcher) {
       if (!(await this.exists(this.pluginPath)))
         await fs.promises.mkdir(this.pluginPath)
       this.watcher = sane(this.pluginPath, {

package/lib/project.js

@@ -47,8 +47,45 @@ module.exports = class WorkerProject extends Project {
     super()
     this.repo = repo
     this.innerFilter = ''
+    this.fileGateway = fileGateway
   }
 
+  init(cb) {
+    this.repo.project = this
+
+    this.pluginManager = new PluginManager(this)
+    this.pluginManager.on('plugin-installed', () => this.emitUpdate())
+    this.pluginManager.on('plugin-uninstalled', () => this.emitUpdate())
+    this.pluginManager.on('plugins-reloaded', () => this.emitUpdate())
+
+    EVENTS.forEach((event) => {
+      this.repo.on(event, (data) => onChange(this, event, data))
+    })
+
+    const promise = new Promise((resolve, reject) => {
+      this.repo.init((err, files) => {
+        if (err) {
+          if (cb) cb(err)
+          else reject(err)
+          return
+        }
+        this.pluginManager
+          .startDevMode()
+          .then(() => {
+            if (cb) cb(null, files)
+            else resolve(files)
+          })
+          .catch(err => {
+            console.log('Error on starting dev mode', err)
+            if (cb) cb(err)
+            else reject(err)
+          })
+      })
+    })
+
+    if (!cb) return promise
+  }
+  
   // HACK:-50 To handle circular dependency issue with file
   toJSON() {
     return { path: this.path }
@@ -114,42 +151,6 @@ module.exports = class WorkerProject extends Project {
     }
   }
 
-  init(cb) {
-    this.repo.project = this
-    this.pluginManager = new PluginManager(this)
-    this.pluginManager.on('plugin-installed', () => this.emitUpdate())
-    this.pluginManager.on('plugin-uninstalled', () => this.emitUpdate())
-    this.pluginManager.on('plugins-reloaded', () => this.emitUpdate())
-
-    EVENTS.forEach((event) => {
-      this.repo.on(event, (data) => onChange(this, event, data))
-    })
-
-    
-    const promise = new Promise((resolve, reject) => {
-      this.repo.init((err, files) => {
-        if (err) {
-          if (cb) cb(err)
-          else reject(err)
-          return
-        }
-        this.pluginManager
-          .startDevMode()
-          .then(() => {
-            if (cb) cb(null, files)
-            else resolve(files)
-          })
-          .catch(err => {
-            console.log('Error on starting dev mode', err)
-            if (cb) cb(err)
-            else reject(err)
-          })
-      })
-    })
-
-    if (!cb) return promise
-  }
-
   emit() {}
 
   emitUpdate() {
@@ -371,13 +372,13 @@ module.exports = class WorkerProject extends Project {
 
   async updateCardContent(task, content) {
     return new Promise((resolve, reject) => {
-      this.repo.modifyTaskFromContent(task, content, (err) => {
+      this.repo.modifyTaskFromContent(task, content, (err, file) => {
         if (err) {
           console.error(err)
           reject(err)
         }
         this.emitUpdate()
-        resolve()
+        resolve(file)
       })
     })
   }
@@ -416,22 +417,6 @@ module.exports = class WorkerProject extends Project {
     this.emit('project.saveFile', { file: filePath, content })
   }
 
-  preparePathForWriting(path) {
-    let stat = fileGateway.statSync(path)
-    if (!stat) {
-      let { dir, ext } = _path.parse(path)
-      if (!ext) {
-        dir = path
-      }
-      fileGateway.mkdirpSync(dir)
-      stat = fileGateway.statSync(path)
-    }
-    return {
-      isFile: stat && stat.isFile(),
-      isDirectory: stat && stat.isDirectory()
-    }
-  }
-
   /*
     * @param {Object} opts - The options object
     * @param {String} opts.list - The list name to add the card to
@@ -442,9 +427,10 @@ module.exports = class WorkerProject extends Project {
     * @param {Boolean} opts.emit - Whether to emit the new card event 
   */
   newCard({ list, path, template, title, comments, emit = true }) {
-    if (!path || !_path.parse(path).ext) path = this.getFullPath(this.getNewCardsFile({title}))
+    if (!path || !_path.parse(path).ext) path = this.getNewCardsFile({title})
+    path = this.getFullPath(path)
 
-    const { isFile, isDirectory } = this.preparePathForWriting(path)
+    const { isFile, isDirectory } = fileGateway.preparePathForWriting(path)
     
     if (!template) template = this.getNewCardTemplate(path, isFile)
     
@@ -559,6 +545,16 @@ module.exports = class WorkerProject extends Project {
     })
   }
 
+  async deleteTasks(tasks) {
+    return new Promise((resolve, reject) => {
+      this.repo.deleteTasks(tasks, async (err) => {
+        if (err) return reject(err)
+        resolve()
+      })
+    })
+  
+  }
+
   setFilter(filter) {
     this.emit('project.filter', { filter })
   }

package/lib/repository.js

@@ -622,12 +622,14 @@ Repository.prototype.readFile = function (file, cb) {
   const checksum = this.checksum || function () {}
   cb = tools.cb(cb)
   if (!File.isFile(file)) return cb(new Error(ERRORS.NOT_A_FILE))
+  if (file.deleted) return cb(null, file)
   var self = this
 
   var currentChecksum = file.checksum
-  if (!/\.\.(\/|\\)/.test(file.path)) {
+  const filePath = file.path
+  if (!/\.\.(\/|\\)/.test(filePath)) {
     this.readFileContent(file, (err, file) => {
-      if (err) return cb(new Error('Unable to read file:' + file))
+      if (err) return cb(new Error('Unable to read file:' + filePath))
       // BACKLOG:-40 Allow user to assign a module for content transformation
       file.checksum = checksum(file.getContent())
       file.updated = currentChecksum !== file.checksum
@@ -966,13 +968,15 @@ Repository.prototype.deleteTask = function (task, cb) {
   if (!cb) throw new Error('task, callback required')
   var self = this
   var file = self.getFileForTask(task)
+  if (!file) return cb(null)
   const execute = function (file) {
     file.deleteTask(task, self.getConfig())
-    if (
-      file.getContentForFile().trim() === '' &&
-      self.config.journalType === constants.JOURNAL_TYPE.NEW_FILE
-    ) {
-      return self.deleteFile(file.path, cb)
+    if (file.getContentForFile().trim() === '') {
+      if (file.deleted) return
+      console.log('Deleting empty file:', file.path)
+      self.deleteFile(file.path, cb)
+      file.deleted = true
+      return
     }
     self.writeAndExtract(file, true, cb)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.45.0",
+  "version": "1.46.0",
   "description": "imdone-core",
   "main": "index.js",
   "scripts": {

package/cli.js

@@ -1,225 +0,0 @@
-#!/usr/bin/env node
-
-const { program } = require('commander');
-const ora = require('ora')
-const chalk = require('chalk')
-const { ChangesExistError } = require('./lib/cli/adapters/Errors')
-const { 
-  imdoneInit, 
-  planStory,
-  startTask,
-  addTask, 
-  listTasks ,
-  completeTask,
-  openBoard,
-  openTaskFile,
-  exportProject
-} = require('./lib/cli/CliControler')
-const {
-  STORY_ID
-} = require('./lib/cli/domain/BacklogProject').constants
-const package = require('./package.json')
-
-const { log } = hideLogs()
-const spinner = ora('Loading unicorns')
-
-setTimeout(() => {
-	spinner.color = 'yellow';
-	spinner.text = 'Loading rainbows';
-}, 1000);
-
-function actionCancelled() {
-  log(chalk.bgRed('Action canceled'))
-}
-
-const STORY_OPTION = `-s, --${STORY_ID} `
-const STORY_OPTION_OPTIONAL = `${STORY_OPTION}[${STORY_ID}]`
-const STORY_OPTION_REQUIRED = `${STORY_OPTION}<${STORY_ID}>`
-
-const mainCmd = program
-.version(package.version, '-v, --version', 'output the current version')
-
-mainCmd
-.command('export')
-.description('Export the current project')
-.action(async function () {
-  try {
-    await exportProject(log)
-  } catch (e) {
-    console.error(e)
-    actionCancelled()
-  } finally {
-    process.exit(0)
-  }
-})
-
-// addDevCmd(mainCmd)
-
-program.parse();
-
-function hideLogs() {
-  const log = console.log
-  const info = console.info
-  const warn = console.warn
-  const logQueue = {warn: [], info: [], log: []}
-  if (!process.env.DEBUG) {
-    Object.keys(logQueue).forEach((key) => {
-      console[key] = function(...args) {
-        logQueue[key].push(args)
-      }
-    })
-  }
-  return {log, info, warn, logQueue}
-}
-
-
-async function planAStory(markdown, storyId, log) {
-  try {
-    await planStory(markdown, storyId, log)
-  } catch (e) {
-    log(chalk.yellowBright(e.message))
-  }
-}
-
-function addDevCmd(mainCmd) {
-  const devCmd = mainCmd
-  .command('dev')
-  .description('Plan and track your storys and tasks')
-
-  devCmd
-  .command('init')
-  .description('initialize backlog')
-  .action(async function () {
-    try {
-      await imdoneInit()
-    } catch (e) {
-      log(chalk.yellowBright(e.message))
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('plan')
-  .option(STORY_OPTION_OPTIONAL, 'Update an existing story\'s tasks')
-  .description('Plan a story with tasks and DoD')
-  .action(async function () {
-    let markdown
-    let { storyId } = this.opts()
-    if (process.stdin.isTTY) {
-      await planAStory(markdown, storyId, log)
-      process.exit(0)
-    } else {
-
-      const stdin = process.stdin;
-      spinner.start()
-
-      markdown = ''
-      
-      stdin.on('readable', function() {
-          var chunk = stdin.read();
-          if(chunk !== null){
-              markdown += chunk;
-          }
-      });
-      stdin.on('end', async function() {
-        await planAStory(markdown, storyId, log)
-        spinner.stop()
-        process.exit(0)
-      });
-    }
-  })
-
-  devCmd
-  .command('open')
-  .description('Open the current or selected task in the default markdown editor')
-  .action(async function () {
-    try {
-      await openTaskFile(log)
-    } catch (e) {
-      log(chalk.yellowBright(e.message))
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('board')
-  .description('Open the current task in imdone')
-  .action(async function () {
-    try {
-      spinner.start()
-      await openBoard(log)
-      spinner.stop()  
-    } catch (e) {
-      log(chalk.yellowBright(e.message))
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('start [task-id]')
-  .description('Start a task by id')
-  .action(async function () {
-    const taskId = this.args.length > 0 ? this.args[0]: null
-    try {
-      await startTask(taskId, log)
-    } catch (e) {
-      if (e instanceof ChangesExistError) {
-        log(chalk.yellowBright(e.message))
-      } else {
-        actionCancelled()
-      }
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('done')
-  .description('Mark the current task as done')
-  .action(async function () {
-    try {
-      await completeTask(log)
-    } catch (e) {
-      actionCancelled()
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('add-task <task-content>')
-  .description('Add a task to a story')
-  .option(STORY_OPTION_REQUIRED, 'The story to add this task to')
-  .option('-g, --group <group>', 'The group to add this task to')
-  .action(async function () {
-    let { storyId, group } = this.opts()
-    try {
-      await addTask({content: this.args[0], storyId, group, log})
-    } catch (e) {
-      actionCancelled()
-    } finally {
-      process.exit(0)
-    }
-  })
-
-  devCmd
-  .command('ls')
-  .description('list tasks')
-  .option(STORY_OPTION_REQUIRED, 'The story to list tasks for')
-  .option('-f, --filter <filter>', 'The filter to use')
-  .option('-j, --json', 'Output as json')
-  .action(async function () {
-    let {storyId, filter, json } = this.opts()
-    try {
-      await listTasks({storyId, filter, json, log})
-    } catch (e) {
-      
-      actionCancelled()
-    } finally {
-      process.exit(0)
-    }
-  })
-}