Add new experimental rule no-empty-file

.announce

@@ -1,7 +1,10 @@
 #!/bin/bash -e
 
 # project.version
-if [ "$VERSION" == "" ]; then exit 1; fi
+if [ "$VERSION" == "" ]; then
+  echo "VERSION has not been set"
+  exit 1;
+fi
 
 if [ "$1" = "-y" ]; then
   AUTOACCEPT=true
@@ -23,43 +26,91 @@ fi
 
 echo "Announcing $PREVIOUS_VERSION -> $VERSION"
 
-COMMIT_MESSAGE="Updated refs to latest ($VERSION) release"
+DOCUMENTATION_DIR="documentation"
+RELEASE_DOCS_DIR="${DOCUMENTATION_DIR}/release-latest"
+SNAPSHOT_DOCS_DIR="${DOCUMENTATION_DIR}/snapshot"
 
-if [ "$(git status --porcelain=v1 docs/install/cli.md docs/install/integrations.md)" != "" ]; then
-  echo "ERROR: To proceed, cli.md and integrations.md must not contain uncommitted changes"
+if [ "$(git status --porcelain=v1 $DOCUMENTATION)" != "" ]; then
+  echo "ERROR: To proceed, the current branch must not contain uncommitted changes in directory '${DOCUMENTATION_DIR}'"
   # ask for user confirmation
   if [[ "$AUTOACCEPT" = false ]]; then
-    read -p "revert changes? (y/n)? " -n 1 -r; echo; if [[ ! $REPLY =~ ^[Yy]$ ]]; then exit 1; else git checkout docs/install/cli.md docs/install/integrations.md; fi
+    read -p "revert changes? (y/n)? " -n 1 -r
+    echo
+    if [[ $REPLY =~ ^[Yy]$ ]]; then
+      git checkout ${DOCUMENTATION_DIR}
+    else
+      exit 1
+    fi
   else
-    echo "Reverting changes to cli.md and integrations.md"
-    git checkout docs/install/cli.md docs/install/integrations.md
+    echo "Reverting changes in directory '${DOCUMENTATION_DIR}'"
+    git checkout ${DOCUMENTATION_DIR}
   fi
 fi
 
-escape_for_sed() { echo "$1" | sed -e 's/[]\/$*.^|[]/\\&/g'; }
+#escape_for_sed() { echo "$1" | sed -e 's/[]\/$*.^|[]/\\&/g'; }
 
-# update Docs
-
-sed -i -e "s/$PREVIOUS_VERSION/$VERSION/g" docs/install/cli.md
-sed -i -e "s/$PREVIOUS_VERSION/$VERSION/g" docs/install/integrations.md
-git --no-pager diff docs/install/cli.md docs/install/integrations.md
-
-# ask for user confirmation
-if [[ "$AUTOACCEPT" = false ]]; then
-  read -p "commit & push (y/n)? " -n 1 -r; echo; if [[ ! $REPLY =~ ^[Yy]$ ]]; then exit 1; fi
-fi
+# Make a separate branch because master branch is protected
 
 BRANCH="$VERSION-update-refs"
-
 if [ "$(git show-ref refs/heads/$BRANCH)" != "" ]; then
   echo "ERROR: Branch $BRANCH already exists."
   if [[ "$AUTOACCEPT" = false ]]; then
-      read -p "Delete local branch? (y/n)? " -n 1 -r; echo; if [[ ! $REPLY =~ ^[Yy]$ ]]; then exit 1; else git branch -D $BRANCH; fi
+      read -p "Delete local branch? (y/n)? " -n 1 -r
+      echo
+      if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        exit 1
+      else
+        git branch -D $BRANCH
+      fi
     else
       echo "Deleting local branch $BRANCH"
       git branch -D $BRANCH
     fi
+  # Checkout local master branch so that changes to this script can be tested without pushing the script to the remote branch
+  git checkout --track master -b $BRANCH
+else
+  git checkout --track origin/master -b $BRANCH
 fi
 
-# Make a separate branch because master branch is protected
-git checkout --track origin/master -b $BRANCH && git commit -m "$COMMIT_MESSAGE" docs/install/cli.md docs/install/integrations.md && git push origin $BRANCH
+# update version number in snapshot docs
+
+echo "Updating version numbers in (snapshot) installation documentation"
+# On local machine (OSX) Use "sed -i '' ..." instead of "sed -i -e ..." as the latter creates a new file.
+# On Github Action workflow the "sed -i -e ..." is required as otherwise it results in failure
+#   "can't read s/0.49.0/0.49.1/g: No such file or directory"
+sed -i -e "s/$PREVIOUS_VERSION/$VERSION/g" ${SNAPSHOT_DOCS_DIR}/docs/install/cli.md
+sed -i -e "s/$PREVIOUS_VERSION/$VERSION/g" ${SNAPSHOT_DOCS_DIR}/docs/install/integrations.md
+git --no-pager diff ${DOCUMENTATION_DIR}
+
+# ask for user confirmation before committing
+if [[ "$AUTOACCEPT" = false ]]; then
+  read -p "Accept changes (y/n)? " -n 1 -r
+  echo
+  if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    exit 1
+  fi
+fi
+
+# Replace release documentation with current snapshot documentation.
+
+echo "Replace release documentation with current snapshot documentation"
+# Support removal of files which still exists in release docs but which are no longer present in snapshot docs
+rm -rf ${RELEASE_DOCS_DIR}/docs/
+cp -r ${SNAPSHOT_DOCS_DIR}/docs/ ${RELEASE_DOCS_DIR}/docs/
+# Note that directory "${SNAPSHOT_DOCS_DIR}/overrides/" should not replace "${RELEASE_DOCS_DIR}/overrides/"
+cp -r ${SNAPSHOT_DOCS_DIR}/mkdocs.yml ${RELEASE_DOCS_DIR}
+# Add files which previously did not yet exists in the release docs but were present in the snapshot docs
+git add --all
+# Display sorted list of files changed but do not show contents as that could be a lot
+git status --porcelain=v1 documentation | sort
+
+# Commit and push changes
+if [[ "$AUTOACCEPT" = false ]]; then
+  read -p "Commit and push changes (y/n)? " -n 1 -r
+  echo
+  if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    exit 1
+  fi
+fi
+git commit -m "Updated refs to latest ($VERSION) release"
+git push origin $BRANCH

.github/workflows/gradle-pr-build.yml → .github/workflows/build-pull-request.yml

@@ -1,9 +1,9 @@
-name: PR Build
+name: Build pull request
 
 on:
   push:
-    branches:
-      - master
+    branches: ['master']
+    paths: ['**/*.kt', '**/*.kts', '**/*.properties', '**/*.toml']
   pull_request:
   workflow_dispatch:
 
@@ -38,4 +38,3 @@ jobs:
         run: ./gradlew build ktlintCheck --no-configuration-cache
       - name: Build with dev Kotlin version
         run: ./gradlew -PkotlinDev build ktlintCheck --no-configuration-cache
-

.github/workflows/gradle-wrapper-validation.yml

@@ -1,4 +1,5 @@
 name: "Validate Gradle Wrapper"
+
 on: [ push, pull_request ]
 
 jobs:

.github/workflows/release.yml → .github/workflows/publish-release-build.yml

@@ -1,4 +1,4 @@
-name: Publish Release
+name: Publish release build
 
 on :
   push :
@@ -35,6 +35,20 @@ jobs:
         if: ${{ success() }}
         uses : ffurrer2/extract-release-notes@v1
 
+      - name: Get version
+        id: get_version
+        if: ${{ success() }}
+        run: echo "version=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+
+      - name: Create zip for dependency managers
+        if: ${{ success() }}
+        run: |
+          cd ktlint-cli/build/run
+          # Doing this for Homebrew and https://github.com/sdkman/sdkman-cli/wiki/Well-formed-SDK-archives
+          mkdir -p ktlint-${{ env.version }}/bin
+          cp ktlint ktlint-${{ env.version }}/bin
+          zip -rm ktlint-${{ env.version }}.zip ktlint-${{ env.version }}
+
       - name : Create release
         id: github_release
         if: ${{ success() }}
@@ -48,26 +62,28 @@ jobs:
         env :
           GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Get version
-        id: get_version
-        if: ${{ success() }}
-        run: echo "version=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
-
       - name: Bump Homebrew Formula
         if: ${{ success() }}
         uses: mislav/bump-homebrew-formula-action@v2
         env:
           COMMITTER_TOKEN: ${{ secrets.HOMEBREW_TOKEN }}
         with:
           formula-name: ktlint
-          download-url: https://github.com/pinterest/ktlint/releases/download/${{ env.version }}/ktlint
+          download-url: https://github.com/pinterest/ktlint/releases/download/${{ env.version }}/ktlint-${{ env.version }}.zip
+
+      - name: Release to sdkman
+        if: false
+        env:
+          SDKMAN_KEY: ${{ secrets.SDKMAN_KEY }}
+          SDKMAN_TOKEN: ${{ secrets.SDKMAN_TOKEN }}
+          SDKMAN_VERSION: ${{ env.version }}
+        run: ./gradlew :ktlint-cli:sdkMajorRelease
 
-      - name: Announce Release
+      - name: Update Release documentation
         if: ${{ success() }}
         run: |
           git config user.email "<>" |
           git config user.name "Ktlint Release Workflow" |
           ./.announce -y
         env:
           VERSION: ${{ env.version }}
-

.github/workflows/publish-release-docs.yml

@@ -0,0 +1,41 @@
+name: Publish release documentation
+
+on:
+  push:
+    branches: ['master']
+    paths: ['documentation/release-latest/**']
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.repository == 'pinterest/ktlint'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # fetch all commits/branches
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install mkdocs and mike
+        run: pip install mkdocs-material mike
+
+      - name: Config git
+        run: |
+          git config user.email "[email protected]"
+          git config user.name "Ktlint Release Workflow"
+
+      - name: Get last released version
+        run: echo "version=$(git describe --abbrev=0 --tags)" >> $GITHUB_ENV
+
+      - name: Deploy release docs
+        run: |
+          echo "Deploy release docs to version ${{ env.version }}"
+          cd documentation/release-latest
+          # Release docs are versioned so that user can use relevant docs for the ktlint version they use
+          mike deploy --push --update-aliases ${{ env.version }} latest
+
+      - name: Update default release docs
+        run: |
+          cd documentation/release-latest
+          mike set-default --push latest

.github/workflows/gradle-snapshot-build.yml → .github/workflows/publish-snapshot-build.yml

@@ -1,8 +1,9 @@
-name: Snapshot Publish
+name: Publish snapshot build
 
 on:
   push:
     branches: [ master ]
+    paths: ['**/*.kt', '**/*.kts', '**/*.properties', '**/*.toml']
 
 env:
   SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}

.github/workflows/publish-snapshot-docs.yml

@@ -0,0 +1,32 @@
+name: Publish snapshot documentation
+
+on:
+  push:
+    branches: ['master']
+    paths: ['documentation/snapshot/**']
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.repository == 'pinterest/ktlint'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # fetch all commits/branches
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install mkdocs and mike
+        run: pip install mkdocs-material mike
+
+      - name: Config git
+        run: |
+          git config user.email "[email protected]"
+          git config user.name "Ktlint Release Workflow"
+
+      - run: |
+          cd documentation/snapshot
+          # The dev-snapshot version has no release number as the version will only be tagged when an official release is build
+          # This also prevents that multiple snapshot versions of the documentation will be published in parallel
+          mike deploy --push dev-snapshot

CHANGELOG.md

@@ -4,15 +4,39 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## Unreleased
 
+### Added
+* Add new experimental rule `no-empty-file` for all code styles. Kotlin file may not be empty.
+
+* Add new experimental rule `no-empty-file` for all code styles. A kotlin (script) file may not be empty ([#1074](https://github.com/pinterest/ktlint/issues/1074))
+
+### Removed
+
+### Fixed
+
+### Changed
+
+## [0.49.1] - 2023-05-12
+
 ### Added
 
 ### Removed
 
 ### Fixed
 * Store path of file containing a lint violation relative to the location of the baseline file itself ([#1962](https://github.com/pinterest/ktlint/issues/1962))
+* Print absolute path of file in lint violations when flag "--relative" is not specified in Ktlint CLI ([#1963](https://github.com/pinterest/ktlint/issues/1963)) 
+* Handle parameter `--code-style=android_studio` in Ktlint CLI identical to deprecated parameter `--android` ([#1982](https://github.com/pinterest/ktlint/issues/1982))
+* Prevent nullpointer exception (NPE) if class without body is followed by multiple blank lines until end of file `no-consecutive-blank-lines` ([#1987](https://github.com/pinterest/ktlint/issues/1987))
+* Allow to 'unset' the `.editorconfig` property `ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than` when using `ktlint_official` code style `function-signature` ([#1977](https://github.com/pinterest/ktlint/issues/1977))
+* Prevent nullpointer exception (NPE) if or operator at start of line is followed by dot qualified expression `indent` ([#1993](https://github.com/pinterest/ktlint/issues/1993))
+* Fix indentation of multiline parameter list in function literal `indent` ([#1976](https://github.com/pinterest/ktlint/issues/1976))
+* Restrict indentation of closing quotes to `ktlint_official` code style to keep formatting of other code styles consistent with `0.48.x` and before `indent` ([#1971](https://github.com/pinterest/ktlint/issues/1971))
+* Extract rule `no-single-line-block-comment` from `comment-wrapping` rule. The `no-single-line-block-comment` rule is added as experimental rule to the `ktlint_official` code style, but it can be enabled explicitly for the other code styles as well. ([#1980](https://github.com/pinterest/ktlint/issues/1980))
+* Clean-up unwanted logging dependencies ([#1998](https://github.com/pinterest/ktlint/issues/1998))
+* Fix directory traversal for patterns referring to paths outside of current working directory or any of it child directories ([#2002](https://github.com/pinterest/ktlint/issues/2002))
 
 ### Changed
-* Separated Baseline functionality out of `ktlint-cli` into separate `ktlint-baseline` module for API consumers
+
+* Moved class `Baseline` from `ktlint-cli` to `ktlint-cli-reporter-baseline` so that Baseline functionality is reusable for API Consumers.
 
 ## [0.49.0] - 2023-04-21
 
@@ -1862,6 +1886,7 @@ set in `[*{kt,kts}]` section).
 
 ## 0.1.0 - 2016-07-27
 
+[0.49.1]: https://github.com/pinterest/ktlint/compare/0.49.0...0.49.1
 [0.49.0]: https://github.com/pinterest/ktlint/compare/0.48.2...0.49.0
 [0.48.2]: https://github.com/pinterest/ktlint/compare/0.48.1...0.48.2
 [0.48.1]: https://github.com/pinterest/ktlint/compare/0.48.0...0.48.1