@toptal/davinci-ci 2.0.8-alpha-fx-2925-use-davinci-by-parts-in-davinci-skeleton.13 → 2.0.9

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 2.0.9
+
+### Patch Changes
+
+- [#1541](https://github.com/toptal/davinci/pull/1541) [`397a53c9`](https://github.com/toptal/davinci/commit/397a53c9add9f7e8d485648b51cd22676d97c78f) Thanks [@TomasSlama](https://github.com/TomasSlama)! - ---
+  - Update documentation about prefering individual davinci packages usage
+
+## 2.0.8
+
+### Patch Changes
+
+- [#1525](https://github.com/toptal/davinci/pull/1525) [`f69a35e`](https://github.com/toptal/davinci/commit/f69a35e2a590b61524d9ab1ce37a03e50012a3c9) Thanks [@denieler](https://github.com/denieler)! - - fix davinci-ci bin executable name
+
 ## 2.0.7
 
 ### Patch Changes

package/README.md

@@ -8,26 +8,26 @@ Watch [this video](https://drive.google.com/file/d/1C5ApkATYCXZ8kTn2LeG5FkM4AveL
 
 ## Installation
 
-Use it by installing `yarn add @toptal/davinci` in your project.
+Use it by installing `yarn add @toptal/davinci-ci` in your project.
 
 ## Usage
 
 ### Commands
 
-- `davinci ci danger` - checks if the PR title and and commit messages comply with [Toptal's standards](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)
+- `davinci-ci danger` - checks if the PR title and and commit messages comply with [Toptal's standards](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)
 
-- `davinci ci danger --conventionalCommits` - checks if the PR title and and commit messages comply with [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/)
+- `davinci-ci danger --conventionalCommits` - checks if the PR title and and commit messages comply with [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/)
 
 To check commit message quality locally just add `--local` argument
 
-`davinci ci danger --local`
+`davinci-ci danger --local`
 
 Using husky, you can check the commit message before pushing files changes.
 
 ```js
 "husky": {
     "hooks": {
-      "pre-push": "yarn davinci ci danger --local"
+      "pre-push": "yarn davinci-ci danger --local"
     }
   },
 ```
@@ -55,7 +55,10 @@ is_progressive_web_app: true
 
 ### Alias
 
-In all the commands you can use `davinci-ci` directly if needed, instead of `davinci ci`. This is not a recommended way to use `davinci`, but in very rare cases it might be useful.
+You can use davinci ci both as a standalone command `davinci-ci [...args]`
+or as a sub-command of the davinci command: `davinci ci [args...]`, in this case @toptal/davinci package is required.
+Recommended way is to use individual davinci packages, i.e. `davinci-ci danger`.
+
 
 ### Commands you can use in GitHub PRs
 

package/dist-package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@toptal/davinci-ci",
+  "version": "2.0.9",
+  "description": "Continuos integrations tools for frontend projects",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "jenkins",
+    "docker",
+    "ci"
+  ],
+  "author": "Toptal",
+  "homepage": "https://github.com/toptal/davinci/tree/master/packages/ci#readme",
+  "license": "ISC",
+  "bin": {
+    "davinci-ci": "./bin/davinci-ci.js"
+  },
+  "main": "./src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/toptal/davinci.git"
+  },
+  "scripts": {
+    "build:package": "../../bin/build-package.js",
+    "prepublishOnly": "../../bin/prepublish.js",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "bugs": {
+    "url": "https://github.com/toptal/davinci/issues"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@toptal/davinci-cli-shared": "1.6.0",
+    "danger": "^11.0.7",
+    "markdown-table": "^2.0.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "2.0.8-alpha-fx-2925-use-davinci-by-parts-in-davinci-skeleton.13+b2d240b7",
+  "version": "2.0.9",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -32,9 +32,8 @@
   "dependencies": {
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.0.3",
-    "@toptal/davinci-cli-shared": "1.6.1-alpha-fx-2925-use-davinci-by-parts-in-davinci-skeleton.13+b2d240b7",
+    "@toptal/davinci-cli-shared": "1.6.0",
     "danger": "^11.0.7",
     "markdown-table": "^2.0.0"
-  },
-  "gitHead": "b2d240b7628e9d089e3f022a2dfcf894409a516f"
+  }
 }

package/src/configs/danger/toptal/plugins/toptal-commits/toptal-commits.test.js

@@ -0,0 +1,128 @@
+const { toptalCommits } = require('.')
+
+const prepareCommitsWithMessages = (messages = []) => ({
+  commits: messages.map(message => ({
+    message,
+    sha: '123',
+  })),
+})
+
+describe('commit danger plugin', () => {
+  beforeEach(() => {
+    global.fail = jest.fn()
+    global.danger = {
+      github: {
+        pr: {
+          user: {
+            login: 'user',
+          },
+        },
+      },
+    }
+  })
+
+  afterEach(() => {
+    global.fail = undefined
+    global.danger = undefined
+  })
+
+  it('commit with title only', () => {
+    global.danger.git = prepareCommitsWithMessages(['Hello world'])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nSome commit body here.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with multi-line body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nFirst line of commit body\nSecond line of commit body',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with title longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'This commit message is a teeny tiny bit longer than allowed length of 79 characters',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit with body lines longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Short commit title\n\nBut this body line commit message is a bit longer than allowed length of 79 characters\nAnd this one is fine again.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit message not starting with an uppercase letter', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '23432 starts with a number',
+      'starts with a lowercase letter',
+      '* starts with a symbol',
+      ' starts with a space',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+
+  it('commit message ending with a period in title', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title ending with period.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit without a blank line between title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title\nBody without a blank line after title',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('valid commit titles', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Regular commit title',
+      'Commit with sentence. But does not end with a full-stop',
+      '[FOO-1234] Commit with prefix',
+      '[FOO] Prefix numbers can be omitted',
+      '[FOO][BAR] Prefixes can couple',
+      '[FOO-1234][BAR] Mixed prefixes',
+      '[FOO-1234][BAR-123][BAZ] Everything. Together',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('invalid commit title prefixes', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '[FOO-1234] commit with lowercase',
+      '[FOO-BAR] Prefix with letter after dash',
+      '[FOO] [BAR] Prefixes with space between',
+      '[FOO]Prefix without space',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+})

package/src/configs/danger/toptal/plugins/toptal-pr-title/toptal-pr-title.test.js

@@ -0,0 +1,68 @@
+const { toptalPRTitle } = require('.')
+const {
+  MISSING_TICKET_CODE_ERROR_MESSAGE,
+  DEFAULT_PR_TITLE_ERROR_MESSAGE,
+} = require('../../config')
+
+const VALID_PR_TITLE = '[ASD-123] Hello world'
+const INVALID_PR_TITLE = '[ASD-123] hello world'
+const NO_TICKET_CODE_PR_TITLE = 'Hello world'
+
+describe('commit danger plugin', () => {
+  beforeEach(() => {
+    global.fail = jest.fn()
+    global.danger = {
+      github: {
+        issue: {
+          labels: [{ name: 'My Team' }],
+        },
+        pr: {
+          title: '',
+          user: {
+            login: 'user',
+          },
+        },
+      },
+    }
+  })
+
+  afterEach(() => {
+    global.fail = undefined
+    global.danger = undefined
+  })
+
+  it('should pass valid PR title', () => {
+    global.danger.github.pr.title = VALID_PR_TITLE
+
+    toptalPRTitle()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('should fail PR title with missing ticket code', () => {
+    global.danger.github.pr.title = NO_TICKET_CODE_PR_TITLE
+
+    toptalPRTitle()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+    expect(global.fail).toHaveBeenCalledWith(MISSING_TICKET_CODE_ERROR_MESSAGE)
+  })
+
+  it('should pass valid PR title with missing ticket code and no-jira label', () => {
+    global.danger.github.pr.title = NO_TICKET_CODE_PR_TITLE
+    global.danger.github.issue.labels = [{ name: 'no-jira' }]
+
+    toptalPRTitle()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('should fail invalid PR title', () => {
+    global.danger.github.pr.title = INVALID_PR_TITLE
+
+    toptalPRTitle()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+    expect(global.fail).toHaveBeenCalledWith(DEFAULT_PR_TITLE_ERROR_MESSAGE)
+  })
+})