feat(core): config enter in log.md

adaltas · Mar 9, 2021 · bb9c496 · bb9c496
1 parent 562299c
commit bb9c496
Show file tree

Hide file tree

Showing 10 changed files with 66 additions and 60 deletions.
diff --git a/packages/core/lib/actions/log/md.js b/packages/core/lib/actions/log/md.js
diff --git a/packages/core/lib/plugins/args.js b/packages/core/lib/plugins/args.js
diff --git a/packages/core/lib/plugins/assertions.js b/packages/core/lib/plugins/assertions.js
diff --git a/packages/core/lib/plugins/assertions_exists.js b/packages/core/lib/plugins/assertions_exists.js
diff --git a/packages/core/lib/plugins/conditions.js b/packages/core/lib/plugins/conditions.js
diff --git a/packages/core/lib/plugins/conditions_execute.js b/packages/core/lib/plugins/conditions_execute.js
diff --git a/packages/core/lib/plugins/conditions_exists.js b/packages/core/lib/plugins/conditions_exists.js
diff --git a/packages/core/lib/plugins/conditions_os.js b/packages/core/lib/plugins/conditions_os.js
diff --git a/packages/core/src/actions/log/md.coffee.md b/packages/core/src/actions/log/md.coffee.md
@@ -3,6 +3,20 @@
 
 Write log to the host filesystem in Markdown.
 
+## Example
+
+```js
+nikita(async function(){
+  await this.log.md({
+    basedir: './logs',
+    filename: 'nikita.log'
+  })
+  await this.call(({tools: {log}}) => {
+    log({message: 'hello'})
+  })
+})
+```
+
 ## Hook
 
     on_action = ({config}) ->
@@ -22,6 +36,12 @@ Write log to the host filesystem in Markdown.
             The characters used to join the hierarchy of headers to create a
             markdown header.
             """
+          enter:
+            type: 'boolean'
+            default: true
+            description: '''
+            Enable or disable the entering messages.
+            '''
       ]
 
 ## Handler
@@ -31,7 +51,8 @@ Write log to the host filesystem in Markdown.
       await @call $: log_fs, config, serializer:
         'nikita:action:start': ({action}) ->
           content = []
-          content.push "\nEntering #{action.metadata.module} (#{(action.metadata.position.map (index) -> index + 1).join '.'})\n" if action.metadata.module
+          if config.enter and action.metadata.module
+            content.push "\nEntering #{action.metadata.module} (#{(action.metadata.position.map (index) -> index + 1).join '.'})\n"
           return content.join '' unless action.metadata.header
           walk = (parent) ->
             precious = parent.metadata.header

diff --git a/packages/core/test/actions/log/md.coffee b/packages/core/test/actions/log/md.coffee
@@ -49,7 +49,7 @@ describe 'actions.log.md', ->
         target: "#{tmpdir}/localhost.log"
         content: 'ok (1.INFO, written by nikita/test/log/md)'
 
-  describe 'header', ->
+  describe 'metadata `header`', ->
 
     they 'honors header', ({ssh}) ->
       nikita
@@ -163,3 +163,20 @@ describe 'actions.log.md', ->
           echo 'this is a second line'
           ```
           """
+
+  describe 'config `enter`', ->
+
+    they 'disabled when false', ({ssh}) ->
+      nikita
+        $ssh: ssh
+        $tmpdir: true
+      , ({metadata: {tmpdir}}) ->
+        await @log.md basedir: tmpdir, enter: false
+        await @call (->)
+        await @call (->)
+        @fs.base.readFile
+          target: "#{tmpdir}/localhost.log"
+          encoding: 'ascii'
+        .should.be.resolvedWith
+          data: ''
+