evertils 0.1.20 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/bin/evertils +2 -2
- data/evertils.gemspec +1 -1
- data/lib/command.rb +3 -3
- data/lib/config.rb +2 -2
- data/lib/constants.rb +3 -3
- data/lib/controller.rb +15 -15
- data/lib/controllers/convert.rb +4 -4
- data/lib/controllers/generate.rb +4 -4
- data/lib/controllers/get.rb +5 -5
- data/lib/controllers/new.rb +4 -4
- data/lib/helper.rb +3 -3
- data/lib/helpers/evernote-enml.rb +2 -2
- data/lib/helpers/evernote-markdown.rb +2 -2
- data/lib/helpers/evernote.rb +4 -4
- data/lib/helpers/generate.rb +2 -2
- data/lib/helpers/results.rb +2 -2
- data/lib/helpers/time.rb +2 -2
- data/lib/kernel.rb +1 -1
- data/lib/log.rb +4 -4
- data/lib/logs.rb +4 -4
- data/lib/model.rb +3 -3
- data/lib/model_data.rb +3 -3
- data/lib/request.rb +2 -2
- data/lib/router.rb +10 -10
- data/lib/utils.rb +2 -2
- data/lib/version.rb +3 -3
- metadata +1 -2
- data/LOGGING_SPECIFICATION.md +0 -50
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 65d895569799db5920d1b76e561a6a363fae85ee
|
4
|
+
data.tar.gz: f1acb30f9bbc5438504d9352977f2d1d159030e5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f3d37d95646c11d7478323ef7f71209babfc096ba21b3bd1f8bb1a0c9cae6e0026a8976a30a0052821283a76bbd6c63d5f1d3f31d9226775dbe4bb5a32df719f
|
7
|
+
data.tar.gz: d005df3a6f82e6e30106816083ca3216730907908b4cb0b5bde02e6681bd90b67f1c6024d19fb5be6803313b0e4d8feeb396108235fb5b80ca08f49bc679f132
|
data/bin/evertils
CHANGED
@@ -35,10 +35,10 @@ require_relative "../lib/helpers/evernote-enml.rb"
|
|
35
35
|
require_relative "../lib/helper.rb"
|
36
36
|
|
37
37
|
# Modify configuration options here
|
38
|
-
$config =
|
38
|
+
$config = Evertils::Cfg.new
|
39
39
|
# Bootstrap!
|
40
40
|
$config.bootstrap!
|
41
41
|
|
42
42
|
# Config file located, route the request
|
43
|
-
req =
|
43
|
+
req = Evertils::Router.new
|
44
44
|
req.route
|
data/evertils.gemspec
CHANGED
data/lib/command.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Command
|
3
3
|
class Exec
|
4
4
|
attr_reader :response, :exitcode
|
@@ -110,7 +110,7 @@ module Granify
|
|
110
110
|
|
111
111
|
def lint(file, log_file)
|
112
112
|
begin
|
113
|
-
command = `coffeelint -f "#{
|
113
|
+
command = `coffeelint -f "#{Evertils::INSTALLED_DIR}/lib/configs/coffeelint.json" #{file}`
|
114
114
|
|
115
115
|
@response = command.include?("Ok!")
|
116
116
|
|
@@ -130,7 +130,7 @@ module Granify
|
|
130
130
|
|
131
131
|
def open_editor(file=nil)
|
132
132
|
begin
|
133
|
-
log_file = file ||
|
133
|
+
log_file = file || Evertils::DEFAULT_LOG
|
134
134
|
|
135
135
|
# System editor is not set/unavailable, use system default to open the
|
136
136
|
# file
|
data/lib/config.rb
CHANGED
data/lib/constants.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
PACKAGE_NAME = "evertils"
|
3
|
-
INSTALLED_DIR = Gem::Specification.find_by_name(
|
3
|
+
INSTALLED_DIR = Gem::Specification.find_by_name(Evertils::PACKAGE_NAME).gem_dir
|
4
4
|
LOG_DIR = INSTALLED_DIR + "/logs"
|
5
5
|
DEFAULT_LOG = Log.new # no args means default log
|
6
6
|
HELPER_DIR = INSTALLED_DIR + "/lib/helpers/"
|
@@ -9,4 +9,4 @@ module Granify
|
|
9
9
|
TEMPLATE_DIR = INSTALLED_DIR + "/lib/configs/templates/"
|
10
10
|
LOG_DIGEST_LENGTH = 20
|
11
11
|
DEBUG = false
|
12
|
-
end
|
12
|
+
end
|
data/lib/controller.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Controller
|
3
3
|
class Base
|
4
4
|
attr_accessor :model, :helper, :methods_require_internet, :default_method
|
@@ -8,7 +8,7 @@ module Granify
|
|
8
8
|
# Perform pre-run tasks
|
9
9
|
def pre_exec
|
10
10
|
OptionParser.new do |opt|
|
11
|
-
opt.banner = "#{
|
11
|
+
opt.banner = "#{Evertils::PACKAGE_NAME} controller command [...-flags]"
|
12
12
|
|
13
13
|
opt.on("-v", "--verbose", "Verbose output") do |v|
|
14
14
|
# short output
|
@@ -17,7 +17,7 @@ module Granify
|
|
17
17
|
|
18
18
|
opt.on("-V", "--version", "Show app version") do |v|
|
19
19
|
# short output
|
20
|
-
@version =
|
20
|
+
@version = Evertils::PACKAGE_VERSION
|
21
21
|
end
|
22
22
|
end.parse!
|
23
23
|
end
|
@@ -34,8 +34,8 @@ module Granify
|
|
34
34
|
|
35
35
|
# Determines if the command can execute
|
36
36
|
def can_exec?(command = nil, name = nil)
|
37
|
-
@model =
|
38
|
-
@helper =
|
37
|
+
@model = Evertils::Model.const_get(command.capitalize).new rescue nil
|
38
|
+
@helper = Evertils::Helper.const_get(command.capitalize).new rescue nil
|
39
39
|
@methods_require_internet = []
|
40
40
|
|
41
41
|
# get user-defined methods to use as a fallback
|
@@ -81,25 +81,25 @@ module Granify
|
|
81
81
|
|
82
82
|
begin
|
83
83
|
modules.each do |mod|
|
84
|
-
if File.exists? "#{
|
85
|
-
require "#{
|
84
|
+
if File.exists? "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
|
85
|
+
require "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
|
86
86
|
|
87
|
-
loaded[:controller][mod] =
|
87
|
+
loaded[:controller][mod] = Evertils::Controller.const_get(mod.capitalize).new
|
88
88
|
else
|
89
89
|
raise StandardError, "Controller not found: #{mod}"
|
90
90
|
end
|
91
91
|
|
92
|
-
if File.exists? "#{
|
93
|
-
require "#{
|
94
|
-
loaded[:helper][mod] =
|
92
|
+
if File.exists? "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
|
93
|
+
require "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
|
94
|
+
loaded[:helper][mod] = Evertils::Helper.const_get(mod.capitalize).new
|
95
95
|
|
96
96
|
# auto-instantiate new instance of helper for the new instance of the controller
|
97
97
|
loaded[:controller][mod].helper = loaded[:helper][mod]
|
98
98
|
end
|
99
99
|
|
100
|
-
if File.exists? "#{
|
101
|
-
require "#{
|
102
|
-
loaded[:model][mod] =
|
100
|
+
if File.exists? "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
|
101
|
+
require "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
|
102
|
+
loaded[:model][mod] = Evertils::Model.const_get(mod.capitalize).new
|
103
103
|
|
104
104
|
# auto-instantiate new instance of model for the new instance of the controller
|
105
105
|
loaded[:controller][mod].model = loaded[:model][mod]
|
@@ -115,4 +115,4 @@ module Granify
|
|
115
115
|
end
|
116
116
|
end
|
117
117
|
end
|
118
|
-
end
|
118
|
+
end
|
data/lib/controllers/convert.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Controller
|
3
3
|
class Convert < Controller::Base
|
4
4
|
attr_accessor :title, :file, :notebook
|
@@ -6,14 +6,14 @@ module Granify
|
|
6
6
|
def pre_exec
|
7
7
|
begin
|
8
8
|
# interface with the Evernote API so we can use it later
|
9
|
-
@model =
|
9
|
+
@model = Evertils::Helper.load('evernote')
|
10
10
|
|
11
11
|
# all methods require internet to make API calls
|
12
12
|
@methods_require_internet.push(:daily, :weekly, :monthly)
|
13
13
|
|
14
14
|
# command flag parser
|
15
15
|
OptionParser.new do |opt|
|
16
|
-
opt.banner = "#{
|
16
|
+
opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
|
17
17
|
|
18
18
|
opt.on("-m", "--to-markdown", "Convert to MD format") do |b|
|
19
19
|
@markdown = b
|
@@ -60,4 +60,4 @@ module Granify
|
|
60
60
|
end
|
61
61
|
end
|
62
62
|
end
|
63
|
-
end
|
63
|
+
end
|
data/lib/controllers/generate.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Controller
|
3
3
|
class Generate < Controller::Base
|
4
4
|
attr_accessor :force, :start
|
@@ -6,7 +6,7 @@ module Granify
|
|
6
6
|
def pre_exec
|
7
7
|
begin
|
8
8
|
# interface with the Evernote API so we can use it later
|
9
|
-
@model =
|
9
|
+
@model = Evertils::Helper.load('evernote')
|
10
10
|
|
11
11
|
# all methods require internet to make API calls
|
12
12
|
@methods_require_internet.push(:daily, :weekly, :monthly, :deployment)
|
@@ -20,7 +20,7 @@ module Granify
|
|
20
20
|
end
|
21
21
|
|
22
22
|
OptionParser.new do |opt|
|
23
|
-
opt.banner = "#{
|
23
|
+
opt.banner = "#{Evertils::PACKAGE_NAME} generate timeframe [...-flags]"
|
24
24
|
|
25
25
|
opt.on("-f", "--force", "Force execution") do
|
26
26
|
@force = true
|
@@ -87,4 +87,4 @@ module Granify
|
|
87
87
|
end
|
88
88
|
end
|
89
89
|
end
|
90
|
-
end
|
90
|
+
end
|
data/lib/controllers/get.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Controller
|
3
3
|
class Get < Controller::Base
|
4
4
|
attr_accessor :title, :file, :notebook
|
@@ -6,14 +6,14 @@ module Granify
|
|
6
6
|
def pre_exec
|
7
7
|
begin
|
8
8
|
# interface with the Evernote API so we can use it later
|
9
|
-
@model =
|
9
|
+
@model = Evertils::Helper.load('evernote')
|
10
10
|
|
11
11
|
# all methods require internet to make API calls
|
12
12
|
@methods_require_internet.push(:daily, :weekly, :monthly)
|
13
13
|
|
14
14
|
# command flag parser
|
15
15
|
OptionParser.new do |opt|
|
16
|
-
opt.banner = "#{
|
16
|
+
opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
|
17
17
|
|
18
18
|
opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
|
19
19
|
@title = title
|
@@ -56,7 +56,7 @@ module Granify
|
|
56
56
|
Notify.error("Could not pull data for notebook #{$request.custom[0]}")
|
57
57
|
end
|
58
58
|
else
|
59
|
-
Notify.error("Notebook name is a required argument, i.e.\n#{
|
59
|
+
Notify.error("Notebook name is a required argument, i.e.\n#{Evertils::PACKAGE_NAME} get notebook agendas")
|
60
60
|
end
|
61
61
|
end
|
62
62
|
|
@@ -67,4 +67,4 @@ module Granify
|
|
67
67
|
end
|
68
68
|
end
|
69
69
|
end
|
70
|
-
end
|
70
|
+
end
|
data/lib/controllers/new.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Controller
|
3
3
|
class New < Controller::Base
|
4
4
|
attr_accessor :title, :file, :notebook
|
@@ -6,7 +6,7 @@ module Granify
|
|
6
6
|
def pre_exec
|
7
7
|
begin
|
8
8
|
# interface with the Evernote API so we can use it later
|
9
|
-
@model =
|
9
|
+
@model = Evertils::Helper.load('evernote')
|
10
10
|
|
11
11
|
# all methods require internet to make API calls
|
12
12
|
@methods_require_internet.push(:daily, :weekly, :monthly)
|
@@ -15,7 +15,7 @@ module Granify
|
|
15
15
|
|
16
16
|
# command flag parser
|
17
17
|
OptionParser.new do |opt|
|
18
|
-
opt.banner = "#{
|
18
|
+
opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
|
19
19
|
|
20
20
|
opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
|
21
21
|
@title = title
|
@@ -97,4 +97,4 @@ module Granify
|
|
97
97
|
end
|
98
98
|
end
|
99
99
|
end
|
100
|
-
end
|
100
|
+
end
|
data/lib/helper.rb
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Helper
|
3
3
|
def self.load(klass, args = nil)
|
4
4
|
begin
|
5
|
-
klass_instance =
|
5
|
+
klass_instance = Evertils::Helper.const_get(klass.capitalize)
|
6
6
|
|
7
7
|
if klass_instance
|
8
8
|
if args.nil?
|
@@ -16,4 +16,4 @@ module Granify
|
|
16
16
|
end
|
17
17
|
end
|
18
18
|
end
|
19
|
-
end
|
19
|
+
end
|
@@ -15,7 +15,7 @@ include Benchmark
|
|
15
15
|
# TODO
|
16
16
|
# - ol numbering is buggy, in fact doesn't matter for markdown code
|
17
17
|
|
18
|
-
module
|
18
|
+
module Evertils
|
19
19
|
module Helper
|
20
20
|
class EvernoteMD
|
21
21
|
# set basic variables:
|
@@ -207,4 +207,4 @@ module Granify
|
|
207
207
|
end
|
208
208
|
end
|
209
209
|
end
|
210
|
-
end
|
210
|
+
end
|
data/lib/helpers/evernote.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Helper
|
3
3
|
class Evernote
|
4
4
|
@@developer_token = ENV["EVERTILS_TOKEN"]
|
@@ -326,9 +326,9 @@ module Granify
|
|
326
326
|
def template_contents
|
327
327
|
if Date.today.friday? && command == :Daily
|
328
328
|
# Friday uses a slightly different template
|
329
|
-
IO.readlines("#{
|
329
|
+
IO.readlines("#{Evertils::TEMPLATE_DIR}#{command}-friday.enml").join("").gsub!("\n", '')
|
330
330
|
else
|
331
|
-
IO.readlines("#{
|
331
|
+
IO.readlines("#{Evertils::TEMPLATE_DIR}#{command}.enml").join("").gsub!("\n", '')
|
332
332
|
end
|
333
333
|
end
|
334
334
|
|
@@ -350,4 +350,4 @@ module Granify
|
|
350
350
|
end
|
351
351
|
end
|
352
352
|
end
|
353
|
-
end
|
353
|
+
end
|
data/lib/helpers/generate.rb
CHANGED
data/lib/helpers/results.rb
CHANGED
data/lib/helpers/time.rb
CHANGED
data/lib/kernel.rb
CHANGED
data/lib/log.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
class Log
|
3
3
|
attr_accessor :path, :total_files_processed
|
4
4
|
attr_reader :template
|
@@ -6,10 +6,10 @@ module Granify
|
|
6
6
|
def initialize(*args)
|
7
7
|
if args.length == 0
|
8
8
|
# default log
|
9
|
-
@template = "#{
|
9
|
+
@template = "#{Evertils::LOG_DIR}/%s"
|
10
10
|
@path = sprintf(@template, "default.log")
|
11
11
|
else
|
12
|
-
@template = "#{
|
12
|
+
@template = "#{Evertils::LOG_DIR}/%s/%s-%s.log"
|
13
13
|
|
14
14
|
format(args)
|
15
15
|
end
|
@@ -108,4 +108,4 @@ module Granify
|
|
108
108
|
File.mtime(@path)
|
109
109
|
end
|
110
110
|
end
|
111
|
-
end
|
111
|
+
end
|
data/lib/logs.rb
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
class Logs
|
3
3
|
MAX_LOGS_TO_STORE = 30
|
4
4
|
|
5
|
-
@files = Dir["#{
|
5
|
+
@files = Dir["#{Evertils::LOG_DIR}/*/*.log"]
|
6
6
|
|
7
7
|
def self.clean
|
8
8
|
if @files.size > 0
|
@@ -19,7 +19,7 @@ module Granify
|
|
19
19
|
|
20
20
|
# Create a directory if required
|
21
21
|
def self.mkdir(name)
|
22
|
-
dir = "#{
|
22
|
+
dir = "#{Evertils::LOG_DIR}/#{name.downcase}"
|
23
23
|
|
24
24
|
if !Dir.exist? dir
|
25
25
|
Dir.mkdir dir
|
@@ -31,4 +31,4 @@ module Granify
|
|
31
31
|
end
|
32
32
|
end
|
33
33
|
end
|
34
|
-
end
|
34
|
+
end
|
data/lib/model.rb
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Model
|
3
3
|
class Base
|
4
4
|
attr_accessor :data, :branch, :browser, :command, :start
|
5
5
|
|
6
6
|
def initialize(hash = nil)
|
7
|
-
@data = hash ||
|
7
|
+
@data = hash || Evertils::Model::Data.new
|
8
8
|
|
9
9
|
# Current time
|
10
10
|
#@time = @data.start
|
@@ -23,4 +23,4 @@ module Granify
|
|
23
23
|
end
|
24
24
|
end
|
25
25
|
end
|
26
|
-
end
|
26
|
+
end
|
data/lib/model_data.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
module Model
|
3
3
|
class Data
|
4
4
|
attr_accessor :identifier, :branch, :browser, :files_with_errors
|
@@ -59,7 +59,7 @@ module Granify
|
|
59
59
|
end
|
60
60
|
|
61
61
|
def log
|
62
|
-
get(:log,
|
62
|
+
get(:log, Evertils::DEFAULT_LOG)
|
63
63
|
end
|
64
64
|
|
65
65
|
def add_to_error_list(file)
|
@@ -94,4 +94,4 @@ module Granify
|
|
94
94
|
end
|
95
95
|
end
|
96
96
|
end
|
97
|
-
end
|
97
|
+
end
|
data/lib/request.rb
CHANGED
data/lib/router.rb
CHANGED
@@ -1,28 +1,28 @@
|
|
1
|
-
module
|
1
|
+
module Evertils
|
2
2
|
class Router
|
3
3
|
def route
|
4
4
|
# Populate request params
|
5
5
|
$request = Request.new
|
6
6
|
|
7
7
|
# include the controller
|
8
|
-
if File.exists? "#{
|
9
|
-
require "#{
|
8
|
+
if File.exists? "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
|
9
|
+
require "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
|
10
10
|
end
|
11
11
|
|
12
12
|
# include helpers
|
13
|
-
if File.exists? "#{
|
14
|
-
require "#{
|
13
|
+
if File.exists? "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
|
14
|
+
require "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
|
15
15
|
end
|
16
16
|
|
17
17
|
# include models
|
18
|
-
if File.exists? "#{
|
19
|
-
require "#{
|
18
|
+
if File.exists? "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
|
19
|
+
require "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
|
20
20
|
end
|
21
21
|
|
22
22
|
# Create object context and pass it the required command line arguments
|
23
23
|
begin
|
24
24
|
if !$request.controller.nil?
|
25
|
-
controller =
|
25
|
+
controller = Evertils::Controller.const_get $request.controller.capitalize rescue false
|
26
26
|
|
27
27
|
if !controller
|
28
28
|
raise "Controller not found: #{$request.controller.capitalize}"
|
@@ -54,7 +54,7 @@ module Granify
|
|
54
54
|
|
55
55
|
if context.methods_require_internet.include? $request.command
|
56
56
|
if !Utils.has_internet_connection?
|
57
|
-
raise RuntimeError, "Command `#{
|
57
|
+
raise RuntimeError, "Command `#{Evertils::PACKAGE_NAME} #{$request.controller} #{$request.command}` requires a connection to the internet.\nPlease check your network configuration settings."
|
58
58
|
end
|
59
59
|
end
|
60
60
|
|
@@ -72,4 +72,4 @@ module Granify
|
|
72
72
|
end
|
73
73
|
end
|
74
74
|
end
|
75
|
-
end
|
75
|
+
end
|
data/lib/utils.rb
CHANGED
data/lib/version.rb
CHANGED
@@ -1,3 +1,3 @@
|
|
1
|
-
module
|
2
|
-
VERSION = '0.
|
3
|
-
end
|
1
|
+
module Evertils
|
2
|
+
VERSION = '0.2.0'
|
3
|
+
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: evertils
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ryan Priebe
|
@@ -19,7 +19,6 @@ extra_rdoc_files: []
|
|
19
19
|
files:
|
20
20
|
- .gitignore
|
21
21
|
- Gemfile
|
22
|
-
- LOGGING_SPECIFICATION.md
|
23
22
|
- README.md
|
24
23
|
- bin/evertils
|
25
24
|
- evertils.gemspec
|
data/LOGGING_SPECIFICATION.md
DELETED
@@ -1,50 +0,0 @@
|
|
1
|
-
## Daily logs
|
2
|
-
* Log location: {COMPANY_NAME} Logs/Daily
|
3
|
-
* Title format: Daily Log [Date - Day of Week]
|
4
|
-
* Tags should be used to denote important/new items
|
5
|
-
* Misc tasks
|
6
|
-
* update expense report sheet every Friday
|
7
|
-
* complete time tracking (Harvest)
|
8
|
-
* create next weekly log
|
9
|
-
* update next week's meeting notes
|
10
|
-
|
11
|
-
## Weekly logs
|
12
|
-
* Log location: {COMPANY_NAME} Logs/Weekly
|
13
|
-
* Title format: Weekly Log [Start of Week Date - End of Week Date]
|
14
|
-
* Link to each daily log and contain a summary of the important items (tags denote important items, use them to determine what the important weekly items are)
|
15
|
-
* Tagged “week-$WEEK_NUM”
|
16
|
-
|
17
|
-
## Monthly logs
|
18
|
-
* Log location: {COMPANY_NAME} Logs/Monthly
|
19
|
-
* Title format: Monthly Log [Month - Year]
|
20
|
-
* Links to each weekly log of that month (table of contents style)
|
21
|
-
* Tagged “month-$MONTH_NUM"
|
22
|
-
|
23
|
-
## Special Tags
|
24
|
-
* borked - I broke something in production
|
25
|
-
* interview - interviewed someone or was part of an interview
|
26
|
-
* meeting - participated in a meeting of some kind
|
27
|
-
|
28
|
-
## Log Templates
|
29
|
-
See [this directory](lib/configs/templates).
|
30
|
-
|
31
|
-
## tl;dr
|
32
|
-
|
33
|
-
Basic setup in Evernote:
|
34
|
-
|
35
|
-
```
|
36
|
-
- {{COMPANY_NAME}} Logs
|
37
|
-
- Daily
|
38
|
-
- Weekly
|
39
|
-
- Monthly
|
40
|
-
```
|
41
|
-
|
42
|
-
To quickly add notes based on a template dictated by the requirements above:
|
43
|
-
|
44
|
-
```shell
|
45
|
-
evertils generate daily # adds a note to Logs/Daily
|
46
|
-
evertils generate weekly # adds a note to Logs/Weekly
|
47
|
-
evertils generate monthly # adds a note to Logs/Monthly
|
48
|
-
```
|
49
|
-
|
50
|
-
Just make sure to update that note every time you do something, otherwise you'll be logging a whole lot of nothing.
|