feat: First checkin

Author: dploeger

.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"]
+}

.gitignore

@@ -0,0 +1,181 @@
+index.js
+index.js.map
+index.d.ts
+lib/**/*.d.ts
+lib/**/*.js
+lib/**/*.js.map
+test/**/*.js
+test/**/*.d.ts
+test/**/*.js.map
+.tscache
+# Created by .ignore support plugin (hsz.mobi)
+### Eclipse template
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+### VisualStudioCode template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+### Jetbrains Missing template
+.idea
+.iml### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+

.prettierignore

@@ -0,0 +1 @@
+package-lock.json

.prettierrc.yaml

@@ -0,0 +1,4 @@
+tabWidth: 2
+semi: false
+printWidth: 140
+singleQuote: true

Gruntfile.js

@@ -0,0 +1,91 @@
+module.exports = function (grunt) {
+  grunt.initConfig({
+    eslint: {
+      files: {
+        src: ['index.ts', 'lib/**/*.ts', 'test/**/*.ts', '!index.d.ts', '!lib/**/*.d.ts', '!test/**/*.d.ts'],
+      },
+    },
+    clean: {
+      coverage: ['test/coverage'],
+    },
+    ts: {
+      default: {
+        tsconfig: true,
+      },
+    },
+    copy: {
+      test: {
+        files: {
+          'test/coverage/instrument/': 'test/**/*.js',
+        },
+        options: {
+          expand: true,
+        },
+      },
+    },
+    instrument: {
+      files: ['index.js', 'lib/**/*.js'],
+      options: {
+        lazy: true,
+        basePath: 'test/coverage/instrument/',
+      },
+    },
+    mochaTest: {
+      test: {
+        options: {
+          reporter: 'spec',
+          quiet: false,
+        },
+        src: ['test/coverage/instrument/test/**/*.js'],
+      },
+    },
+    storeCoverage: {
+      options: {
+        dir: 'test/coverage/reports',
+      },
+    },
+    remapIstanbul: {
+      build: {
+        src: 'test/coverage/reports/coverage.json',
+        options: {
+          reports: {
+            json: 'test/coverage/reports/coverage-mapped.json',
+          },
+        },
+      },
+    },
+    makeReport: {
+      src: 'test/coverage/reports/coverage-mapped.json',
+      options: {
+        type: 'lcov',
+        dir: 'test/coverage/reports',
+        print: 'detail',
+      },
+    },
+  })
+
+  grunt.loadNpmTasks('grunt-ts')
+  grunt.loadNpmTasks('grunt-eslint')
+  grunt.loadNpmTasks('grunt-mocha-test')
+  grunt.loadNpmTasks('grunt-istanbul')
+  grunt.loadNpmTasks('remap-istanbul')
+  grunt.loadNpmTasks('grunt-contrib-clean')
+  grunt.loadNpmTasks('grunt-contrib-copy')
+
+  grunt.registerTask('build', ['eslint', 'ts'])
+
+  grunt.registerTask('default', ['build'])
+
+  grunt.registerTask('test', [
+    'build',
+    'clean:coverage',
+    'copy:test',
+    'instrument',
+    'mochaTest:test',
+    'storeCoverage',
+    'remapIstanbul',
+    'makeReport',
+  ])
+
+  grunt.registerTask('release', ['test'])
+}

README.md

@@ -0,0 +1,11 @@
+# confluence-outdated - Constant validation of Confluence document outdates
+
+## Introduction
+
+Tell something about your typescript module.
+
+## Building
+
+To test and build this package, simply use grunt:
+
+    grunt test

index.ts

@@ -0,0 +1,36 @@
+/**
+ * @module confluence-outdated
+ */
+/**
+ */
+
+// import needed modules
+
+import * as loglevel from 'loglevel'
+import Bluebird = require('bluebird')
+
+/**
+ * confluence-outdated - Constant validation of Confluence document outdates
+ */
+export class ExampleClass {
+  /**
+   * Use a logger instance to log, what you're doing
+   */
+  private _log: loglevel.Logger = null
+
+  constructor() {
+    this._log = loglevel.getLogger('confluence-outdated:ExampleClass')
+  }
+
+  /**
+   * Be nice.
+   * @param {string} name Who are you?
+   * @return {Bluebird<string>} My greets to you
+   */
+  public helloWorld(name: string): Bluebird<string> {
+    if (name === '') {
+      return Bluebird.reject(new Error('Found nobody to greet'))
+    }
+    return Bluebird.resolve(`Hello ${name}`)
+  }
+}

lib/api/check.ts

@@ -0,0 +1,27 @@
+/**
+ * A description of a check
+ */
+export interface Check {
+  /**
+   * A list of labels that the document must have
+   */
+  labels: Array<string>
+
+  /**
+   * The maximum age of the document
+   */
+  maxAge: number
+}
+
+/**
+ * An implementation of the check interface
+ */
+export class Check implements Check {
+  public labels: Array<string>
+  public maxAge: number
+
+  constructor(labels: Array<string>, maxAge: number) {
+    this.labels = labels
+    this.maxAge = maxAge
+  }
+}