Skip to content

Fix/enable worktrees sui precommit #1968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulusrex merged 3 commits into from
Feb 5, 2026
+86 −27
Merged

Fix/enable worktrees sui precommit #1968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
527fc2f
fix(packages/sui-precommit): allow npm install on git worktrees
Feb 3, 2026
04a4940
docs(packages/sui-precommit): add worktrees compatibility
Feb 3, 2026
1b602cf
refactor(packages/sui-precommit): remove top level await
Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/sui-precommit/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ It provides:
$ npm install @s-ui/precommit --save-dev
```

## Git Worktree Support

`@s-ui/precommit` automatically detects and supports git worktrees. Whether you're working in a normal git repository or a worktree, the hooks will be installed in the correct location automatically.

When used in a worktree, hooks are installed in the main repository's worktree-specific hooks directory, ensuring proper git hook execution.

## CLI

### `$ sui-precommit`
Expand Down
107 changes: 80 additions & 27 deletions packages/sui-precommit/bin/sui-precommit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

// @ts-check

import {existsSync, readFileSync, writeFileSync} from 'fs'
import {existsSync, mkdirSync, readFileSync, statSync, writeFileSync} from 'fs'
import {chmod, writeFile} from 'fs/promises'
import {join} from 'path'

Expand All @@ -22,42 +22,95 @@ const {name} = readPackageJson()
** - for CI and the same precommit package
** - for the `@s-ui/precommit` pkg itself */

/**
* Get the actual git directory path, handling both normal repos and worktrees.
* In a worktree, .git is a file containing a reference to the actual git directory.
* @param {string} gitPath - Path to the .git file or directory
* @returns {string} Path to the actual git directory
*/
function getGitDirectory(gitPath) {
const gitStat = statSync(gitPath)

if (gitStat.isDirectory()) {
// Normal git repository
return gitPath
} else if (gitStat.isFile()) {
// Git worktree - read and parse the gitdir reference
const gitFileContent = readFileSync(gitPath, {encoding: 'utf8'}).trim()

// Expected format: "gitdir: /path/to/actual/.git/worktrees/name"
const match = gitFileContent.match(/^gitdir:\s*(.+)$/)

if (!match) {
throw new Error(`Invalid .git file format: ${gitFileContent}`)
}

const gitDir = match[1].trim()

// Validate the referenced directory exists
if (!existsSync(gitDir)) {
throw new Error(`Git directory referenced in .git file does not exist: ${gitDir}`)
}

return gitDir
} else {
throw new Error('.git exists but is neither a file nor a directory')
}
}

if (CI === false && name !== '@s-ui/precommit') {
const hooksPath = join(cwd, '.git')
const gitPath = join(cwd, '.git')

/**
* Check if hooks directory exists. If not, it means
* Check if .git exists. If not, it means
* the project is not a Git Repository and it doesn't
* make sense to install Git hooks for now.
*/
if (!existsSync(hooksPath)) {
if (!existsSync(gitPath)) {
log('No .git folder found. Skipping precommit hooks installation...')
process.exit(0)
}

log('Installing precommit hooks...')

const commitMsgPath = `${hooksPath}/hooks/commit-msg`
const preCommitPath = `${hooksPath}/hooks/pre-commit`
const prePushPath = `${hooksPath}/hooks/pre-push`

Promise.all([
writeFile(commitMsgPath, '#!/bin/sh\nnpm run commit-msg --if-present'),
writeFile(preCommitPath, '#!/bin/sh\nnpm run pre-commit --if-present'),
writeFile(prePushPath, '#!/bin/sh\nnpm run pre-push --if-present')
]).then(() => Promise.all([chmod(commitMsgPath, '755'), chmod(preCommitPath, '755'), chmod(prePushPath, '755')]))

try {
addToPackageJson('sui-lint js --staged && sui-lint sass --staged', 'scripts.lint', false)
addToPackageJson('echo "Skipping tests as they are not present"', 'scripts.test', false)
addToPackageJson('npm run lint', 'scripts.pre-commit', false)
addToPackageJson('npm run test', 'scripts.pre-push', false)
removeFromPackageJson('husky')
} catch (err) {
log(err.message)
log('[@s-ui/precommit] Installation has FAILED.')
process.exit(1)
}
Promise.resolve()
.then(() => {
// Get the actual git directory (handles both normal repos and worktrees)
const gitDirectory = getGitDirectory(gitPath)
const hooksPath = join(gitDirectory, 'hooks')

// Ensure hooks directory exists (important for worktrees)
if (!existsSync(hooksPath)) {
mkdirSync(hooksPath, {recursive: true})
log('Created hooks directory...')
}

log('Installing precommit hooks...')

const commitMsgPath = join(hooksPath, 'commit-msg')
const preCommitPath = join(hooksPath, 'pre-commit')
const prePushPath = join(hooksPath, 'pre-push')

return {commitMsgPath, preCommitPath, prePushPath}
})
.then(({commitMsgPath, preCommitPath, prePushPath}) =>
Promise.all([
writeFile(commitMsgPath, '#!/bin/sh\nnpm run commit-msg --if-present'),
writeFile(preCommitPath, '#!/bin/sh\nnpm run pre-commit --if-present'),
writeFile(prePushPath, '#!/bin/sh\nnpm run pre-push --if-present')
]).then(() => Promise.all([chmod(commitMsgPath, '755'), chmod(preCommitPath, '755'), chmod(prePushPath, '755')]))
)
.then(() => {
// Add package.json modifications
addToPackageJson('sui-lint js --staged && sui-lint sass --staged', 'scripts.lint', false)
addToPackageJson('echo "Skipping tests as they are not present"', 'scripts.test', false)
addToPackageJson('npm run lint', 'scripts.pre-commit', false)
addToPackageJson('npm run test', 'scripts.pre-push', false)
removeFromPackageJson('husky')
})
.catch(err => {
log(err.message)
log('[@s-ui/precommit] Installation has FAILED.')
process.exit(1)
})
}

function log(...args) {
Expand Down