Merge branch 'master' of github.com:infinitered/solidarity

Author: GantMan

.travis.yml

@@ -16,7 +16,7 @@ notifications:
     urls:
       - 'https://www.travisbuddy.com/'
     on_success: never
-    on_failure: always
+    on_failure: never
     on_start: never
     on_cancel: never
     on_error: never

README.md

@@ -71,6 +71,16 @@ No `.solidarity` file found for this project.  Would you like to create one? (Y/
 
 Custom rule-sets can be created by modifying the `.solidarity` file by hand, or by creating a solidarity plugin for a given technology.  [See documentation](https://infinitered.github.io/solidarity/) for how you can create your own.
 
+## How do I update my snapshots?
+Given there is already a `.solidarity` file present, then you can run `solidarity snapshot [rule]`
+
+```sh
+$ solidarity snapshot cli node
+```
+
+Solidarity will follow up with aditional questions to help drill down your new snapshot rule.
+
+
 ## Cross Platform
 Solidarity works with Mac/Linux/Windows environments. CI tests all rules with each platform on every update.
 

__tests__/command_helpers/appendSolidaritySettings.ts

@@ -1,7 +1,6 @@
 import appendSolidaritySettings from '../../src/extensions/functions/appendSolidaritySettings'
 import { keys } from 'ramda'
 import solidarityExtension from '../../src/extensions/solidarity-extension'
-import { solidarity } from '../../src/types'
 
 const context = require('mockContext')
 

__tests__/command_helpers/checkCLIForUpdates.ts

@@ -33,7 +33,7 @@ describe('checkCLIForUpdates', () => {
       rule.binary = 'yarn'
       context.print = {
         colors: {
-          green: jest.fn(string => string),
+          green: jest.fn(stringy => stringy),
         },
       }
     })

__tests__/command_helpers/checkENV.ts

@@ -15,7 +15,6 @@ test('checkENV detects set ENV', async () => {
     }
     // Use checkENV to make sure it exists
     expect(await checkENV({ variable: someRealEnvVar })).toBeTruthy()
-  } else {
   }
 })
 

__tests__/command_helpers/checkRequirement.ts

@@ -1,4 +1,3 @@
-import { SolidarityRequirement } from '../../dist/types'
 import { toPairs } from 'ramda'
 import { strings } from 'gluegun/toolbox'
 
@@ -59,7 +58,7 @@ describe('checkRequirement', () => {
   })
 
   test('there is a spinner message', async () => {
-    const result = await checkRequirement(badRule, context)
+    await checkRequirement(badRule, context)
     expect(context.print.spin.mock.calls).toEqual([['Verifying YARN']])
   })
 

__tests__/command_helpers/checkShell.ts

@@ -1,4 +1,3 @@
-import { ShellRule, SolidarityRunContext } from '../../src/types'
 import { strings } from 'gluegun/toolbox'
 const checkShell: any = require('../../src/extensions/functions/checkShell')
 

__tests__/command_helpers/getSolidaritySettings.ts

@@ -1,4 +1,3 @@
-import { solidarity } from '../../src'
 import getSolidaritySettings from '../../src/extensions/functions/getSolidaritySettings'
 
 const context = require('mockContext')
@@ -26,15 +25,15 @@ describe('basic getSolidaritySettings', () => {
     test('getSolidaritySettings can fail', () => {
       expect(() => {
         process.chdir('__tests__')
-        const resultSettings = getSolidaritySettings(context)
+        getSolidaritySettings(context)
       }).toThrow()
       process.chdir('../')
     })
 
     test('getSolidaritySettings can warn with missing requirements', () => {
       expect(() => {
         process.chdir('__tests__/sandbox/solidarity_broken')
-        const resultSettings = getSolidaritySettings(context)
+        getSolidaritySettings(context)
       }).toThrowError('ERROR: Found, but no requirements key.  Please validate your solidarity file')
       process.chdir('../../../')
     })
@@ -62,12 +61,12 @@ describe('parameterized getSolidaritySettings', () => {
     // test longhand
     context.parameters.options = { solidarityFile: '__tests__/fake' }
     expect(() => {
-      const resultSettings = getSolidaritySettings(context)
+      getSolidaritySettings(context)
     }).toThrowError('ERROR: There is no solidarity file at the given path')
     // test shorthand
     context.parameters.options = { f: '__tests__/fake' }
     expect(() => {
-      const resultSettings = getSolidaritySettings(context)
+      getSolidaritySettings(context)
     }).toThrowError('ERROR: There is no solidarity file at the given path')
     context.parameters.options = {}
   })
@@ -104,7 +103,7 @@ describe('parameterized getSolidaritySettings', () => {
     test('errors if no solidarity file in module', () => {
       context.parameters.options = { module: 'nope' }
       expect(() => {
-        const resultSettings = getSolidaritySettings(context)
+        getSolidaritySettings(context)
       }).toThrowError('ERROR: There is no solidarity file found with the given module')
       context.parameters.options = {}
     })

__tests__/command_helpers/reviewRule.ts

@@ -15,7 +15,7 @@ describe('reviewRule', () => {
     test('rule gets added', async () => {
       const rule = ['NPM', [{ rule: 'cli', binary: 'npm' }]]
 
-      const result = await reviewRule(rule, reportResults, mockContext)
+      await reviewRule(rule, reportResults, mockContext)
       // CLI rule was added
       expect(reportResults.cliRules.length).toBe(2)
     })
@@ -25,7 +25,7 @@ describe('reviewRule', () => {
     test('rule gets added', async () => {
       const rule = ['ANDROID', [{ rule: 'env', value: 'ANDROID_HOME' }]]
 
-      const result = await reviewRule(rule, reportResults, mockContext)
+      reviewRule(rule, reportResults, mockContext)
       // CLI rule was added
       expect(reportResults.envRules.length).toBe(2)
     })
@@ -35,7 +35,7 @@ describe('reviewRule', () => {
     test('rule gets added', async () => {
       const rule = ['DIRECTORY', [{ rule: 'dir', binary: 'random' }]]
 
-      const result = await reviewRule(rule, reportResults, mockContext)
+      reviewRule(rule, reportResults, mockContext)
       // CLI rule was added
       expect(reportResults.filesystemRules.length).toBe(2)
     })
@@ -45,7 +45,7 @@ describe('reviewRule', () => {
     test('rule gets added', async () => {
       const rule = ['FILE', [{ rule: 'file', binary: 'random' }]]
 
-      const result = await reviewRule(rule, reportResults, mockContext)
+      reviewRule(rule, reportResults, mockContext)
       // CLI rule was added
       expect(reportResults.filesystemRules.length).toBe(2)
     })
@@ -55,9 +55,9 @@ describe('reviewRule', () => {
     test('rule gets added', async () => {
       const rule = ['SHELL', [{ rule: 'shell', command: 'ls', match: '.+' }]]
 
-      const result = await reviewRule(rule, reportResults, mockContext)
+      reviewRule(rule, reportResults, mockContext)
       // SHELL rule was added
-      expect(reportResults.shellRules.length).toBe(2)
+      expect(reportResults.shellRules.length).toBe(1)
     })
   })
 
@@ -67,7 +67,7 @@ describe('reviewRule', () => {
       const rule = ['CUSTOM', [{ rule: 'custom', plugin: 'Example Plugin', name: 'checkThing' }]]
 
       expect(reportResults.cliRules.length).toBe(1)
-      const result = await reviewRule(rule, reportResults, mockContext)
+      await reviewRule(rule, reportResults, mockContext)
       // CUSTOM rule (which adds CLI report) was added
       expect(reportResults.cliRules.length).toBe(2)
     })
@@ -76,7 +76,7 @@ describe('reviewRule', () => {
       const rule = ['CUSTOM', [{ rule: 'custom', plugin: 'Example Plugin', name: 'checkSecondThing' }]]
 
       expect(reportResults.cliRules.length).toBe(1)
-      const result = await reviewRule(rule, reportResults, mockContext)
+      await reviewRule(rule, reportResults, mockContext)
       // should not change rules
       expect(reportResults.cliRules.length).toBe(1)
     })

__tests__/command_helpers/solidarityReport.ts

@@ -2,7 +2,6 @@ import { SolidarityReportResults } from '../../src/types'
 import { createReport } from '../../src/extensions/functions/solidarityReport'
 const context = require('mockContext')
 
-let reportResults: SolidarityReportResults
 describe('solidarityReport structure', () => {
   test('the basic function generates the Result object', () => {
     let report = createReport(context)