Merge remote-tracking branch 'origin/master'

Author: toplenboren

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '28 7 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

README.md

@@ -5,7 +5,10 @@
 
 A tool that lets you easily manage git hooks
 
-> The package was recently renamed from `simple-pre-commit`. See **Releases** for the `simple-pre-commit` documentation.
+> The package was recently renamed from `simple-pre-commit`. 
+
+
+> See **Releases** for the `simple-pre-commit` documentation and changelog
 
 - Zero dependency
 - Small configuration (1 object in package.json)
@@ -116,11 +119,11 @@ Note that you should manually run `npx simple-git-hooks` **every time you change
 
 ### Additional configuration options
 
-You can also add a `.simple-git-hooks.js`, `simple-git-hooks.js`, `.simple-git-hooks.json` or `simple-git-hooks.json` file to the project and write the configuration inside it.
+You can also add a `.simple-git-hooks.cjs`, `.simple-git-hooks.js`, `simple-git-hooks.cjs`, `simple-git-hooks.js`, `.simple-git-hooks.json` or `simple-git-hooks.json` file to the project and write the configuration inside it.
 
 This way `simple-git-hooks` configuration in `package.json` will not take effect any more.
 
-`.simple-git-hooks.js` or `simple-git-hooks.js` should look like the following.
+`.simple-git-hooks.cjs`, `.simple-git-hooks.js` or `simple-git-hooks.cjs`, `simple-git-hooks.js` should look like the following.
 
 ```js
 module.exports = {

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| all.    | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+drop an email to [email protected]

_tests/project_with_configuration_in_alternative_separate_cjs/.simple-git-hooks.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  "pre-push": "exit 1",
+  "pre-commit": "exit 1"
+}

_tests/project_with_configuration_in_alternative_separate_cjs/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "simple-pre-commit-test-package",
+  "version": "1.0.0",
+  "devDependencies": {
+    "simple-git-hooks": "1.0.0"
+  }
+}

_tests/project_with_configuration_in_separate_cjs/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "simple-pre-commit-test-package",
+  "version": "1.0.0",
+  "devDependencies": {
+    "simple-git-hooks": "1.0.0"
+  }
+}

_tests/project_with_configuration_in_separate_cjs/simple-git-hooks.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  "pre-push": "exit 1",
+  "pre-commit": "exit 1"
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-git-hooks",
-  "version": "2.4.1",
+  "version": "2.5.1",
   "description": "A simple, zero dependency tool for setting up git hooks for small projects",
   "author": "Mikhail Gorbunov <[email protected]> (toplenboren.github.io)",
   "main": "simple-git-hooks.js",

simple-git-hooks.js

@@ -238,7 +238,9 @@ function _getConfig(projectRootPath) {
 
     // every function here should accept projectRootPath as first argument and return object
     const sources = [
+        () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.cjs'),
         () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.js'),
+        () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.cjs'),
         () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.js'),
         () => _getConfigFromFile(projectRootPath, '.simple-git-hooks.json'),
         () => _getConfigFromFile(projectRootPath, 'simple-git-hooks.json'),

simple-git-hooks.test.js

@@ -70,7 +70,9 @@ const testsFolder = path.normalize(path.join(process.cwd(), '_tests'))
 // Correct configurations
 
 const projectWithConfigurationInPackageJsonPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_package_json'))
+const projectWithConfigurationInSeparateCjsPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_separate_cjs'))
 const projectWithConfigurationInSeparateJsPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_separate_js'))
+const projectWithConfigurationInAlternativeSeparateCjsPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_alternative_separate_cjs'))
 const projectWithConfigurationInAlternativeSeparateJsPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_alternative_separate_js'))
 const projectWithConfigurationInSeparateJsonPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_separate_json'))
 const projectWithConfigurationInAlternativeSeparateJsonPath = path.normalize(path.join(testsFolder, 'project_with_configuration_in_alternative_separate_json'))
@@ -129,6 +131,26 @@ test('creates git hooks if configuration is correct from .simple-git-hooks.js',
     removeGitHooksFolder(projectWithConfigurationInAlternativeSeparateJsPath)
 })
 
+test('creates git hooks if configuration is correct from .simple-git-hooks.cjs', () => {
+    createGitHooksFolder(projectWithConfigurationInAlternativeSeparateCjsPath)
+
+    spc.setHooksFromConfig(projectWithConfigurationInAlternativeSeparateCjsPath)
+    const installedHooks = getInstalledGitHooks(path.normalize(path.join(projectWithConfigurationInAlternativeSeparateCjsPath, '.git', 'hooks')))
+    expect(JSON.stringify(installedHooks)).toBe(JSON.stringify({'pre-commit':`#!/bin/sh\nexit 1`, 'pre-push':`#!/bin/sh\nexit 1`}))
+
+    removeGitHooksFolder(projectWithConfigurationInAlternativeSeparateCjsPath)
+})
+
+test('creates git hooks if configuration is correct from simple-git-hooks.cjs', () => {
+    createGitHooksFolder(projectWithConfigurationInSeparateCjsPath)
+
+    spc.setHooksFromConfig(projectWithConfigurationInSeparateCjsPath)
+    const installedHooks = getInstalledGitHooks(path.normalize(path.join(projectWithConfigurationInSeparateCjsPath, '.git', 'hooks')))
+    expect(JSON.stringify(installedHooks)).toBe(JSON.stringify({'pre-commit':`#!/bin/sh\nexit 1`, 'pre-push':`#!/bin/sh\nexit 1`}))
+
+    removeGitHooksFolder(projectWithConfigurationInSeparateCjsPath)
+})
+
 test('creates git hooks if configuration is correct from simple-git-hooks.js', () => {
     createGitHooksFolder(projectWithConfigurationInSeparateJsPath)
 
@@ -139,7 +161,6 @@ test('creates git hooks if configuration is correct from simple-git-hooks.js', (
     removeGitHooksFolder(projectWithConfigurationInSeparateJsPath)
 })
 
-
 test('creates git hooks if configuration is correct from .simple-git-hooks.json', () => {
     createGitHooksFolder(projectWithConfigurationInAlternativeSeparateJsonPath)