@beauraines/rtm-cli 1.5.8 → 1.6.0

package/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+    }
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/.github/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x,18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [1.6.0](https://github.com/beauraines/rtm-cli/compare/v1.5.1...v1.6.0) (2023-03-05)
+
+
+### Features
+
+* Display the full task information ([#22](https://github.com/beauraines/rtm-cli/issues/22)) ([c5f1b1a](https://github.com/beauraines/rtm-cli/commit/c5f1b1ac9734decf557005f49294c8030658d105)), closes [#17](https://github.com/beauraines/rtm-cli/issues/17)

package/jest.config.js

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/8s/3xlngh6x3734dvdvgk4235_r0000gp/T/jest_dy",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  verbose: true,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-cli",
-  "version": "1.5.8",
+  "version": "1.6.0",
   "description": "RTM CLI",
   "keywords": [
     "rtm",
@@ -18,7 +18,12 @@
   "main": "src/utils/index.js",
   "scripts": {
     "postversion": "npm run build",
-    "build": "node build.js"
+    "build": "node build.js",
+    "test": "jest --passWithNoTests",
+    "lint": "eslint src",
+    "lintfix": "eslint src --fix",
+    "release": "standard-version",
+    "should-release": "should-release"
   },
   "repository": {
     "type": "git",
@@ -33,26 +38,31 @@
   "dependencies": {
     "@beauraines/rtm-api": "^1.4.1",
     "chalk": "^2.3.0",
-    "cli-table3": "^0.5.0",
-    "commander": "^2.11.0",
+    "cli-table3": "^0.6.3",
+    "commander": "^10.0.0",
     "copy-paste": "^1.3.0",
     "dateformat": "^3.0.2",
     "deepmerge": "^2.0.1",
     "opn": "^5.4.0",
     "ora": "^1.3.0",
     "prompt-sync": "^4.2.0",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0",
     "window-size": "^1.1.0"
   },
   "devDependencies": {
     "archiver": "^2.1.0",
-    "pkg": "^4.3.3"
+    "eslint": "^8.34.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.4.3",
+    "pkg": "^5.8.0"
   },
   "pkg": {
     "scripts": [
       "config.json",
       "src/cmd/*.js"
     ],
-    "targets": "node8-linux-x86,node8-linux-x64,node8-macos-x86,node8-macos-x64,node8-win-x86,node8-win-x64",
+    "targets": "latest-linux-x64,latest-macos-x64,latest-win-x64",
     "out": "./bin"
   }
 }

package/src/cmd/task.js

@@ -0,0 +1,116 @@
+'use strict';
+
+const log = require('../utils/log.js');
+const config = require('../utils/config.js');
+const finish = require('../utils/finish.js');
+const filter = require('../utils/filter');
+const { indexPrompt } = require('../utils/prompt')
+
+
+let TASKS = [];
+
+// Get Display Styles
+let styles = config.get().styles;
+
+/**
+ * This command displays all task details
+ * @param args index
+ * @param env
+ */
+async function action(args, env) {
+
+  // Reset TASKS
+  TASKS = [];
+
+  const user = config.user(user => user)
+
+  let indices = []
+
+  // Prompt for task
+  if ( args.length < 1 ) {
+    indices = indexPrompt('Task:')
+    args[0] = indices
+  }
+
+
+  log.spinner.start("Getting Task(s)");
+  // Use provided args
+  for (const arg in args[0]) {
+      if (Object.hasOwnProperty.call(args[0], arg)) {
+          const index = args[0][arg];
+          const filterString = filter();
+          let task =  await user.tasks.rtmIndexFetchTask(index,filterString)
+          if (task.err == undefined ) {
+              task = task.task
+          } else {
+            log.spinner.warn('Task #' + index + ' is not found');
+          }
+
+          // Push to TASKS
+          TASKS.push({
+            index: index,
+            task
+          });
+
+      }
+  }
+  // Print TASKS
+  log.spinner.stop();
+  for ( let i = 0; i < TASKS.length; i++ ) {
+    displayTask(TASKS[i]);
+  }
+  
+  
+  finish()
+  
+  
+}
+
+
+module.exports = {
+  command: 'task [indices...]',
+  options: [],
+  description: 'Display the Task details',
+  action: action
+};
+
+function displayTask(taskDetails) {
+  let index = taskDetails.index;
+  // eslint-disable-next-line no-unused-vars
+  const { _list, list_id, taskseries_id, task_id, _index, name, priority, start, due, completed, isRecurring, isSubtask, estimate, url, tags, notes ,...otherAttributes } = taskDetails.task;
+  log.style(index + " " + name,styles.list,true);
+  log.style(`List: `,styles.index)
+  log(`${list_id}`) // TODO lookup the list name
+  log.style(`Priority: `,styles.index)
+  log.style(`${priority}`,styles.priority[priority],true)
+  log.style(`Start: `,styles.index)
+  log(`${start}`)
+  log.style(`Due: `,styles.index)
+  log(`${due}`)
+  log.style(`Completed: `,styles.index)
+  log(`${completed}`)
+  log.style(`Is Recurring: `,styles.index)
+  log(`${isRecurring}`)
+  log.style(`Is Subtask: `,styles.index)
+  log(`${isSubtask}`)
+  log.style(`Estimate: `,styles.index)
+  log(`${estimate}`)
+  log.style(`Url: `,styles.index)
+  log(`${url}`)
+  log.style(`Tags: `,styles.index)
+  log.style(`${tags}`,styles.tags, true)
+  log.style(`Notes: `,styles.index)
+  for (const note of notes) {
+    log.style(note.title ? note.title : '',true);
+    log('========');
+    log(note.body);
+    log();
+  }
+
+  // Displays all the other attributes. This will allow more attributes to be added to a RTMTask and they'll still be displayed.
+  for (const [key, value] of Object.entries(otherAttributes)) {
+    log.style(`${key}: `, styles.index, false);
+    log(`${value}`);
+  }
+  log()
+}