# commit-to-timesheet-log

> Package to help automate timesheet log from git commits.

Latest version **1.0.4** (published 2022-06-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install commit-to-timesheet-log
pnpm add commit-to-timesheet-log
yarn add commit-to-timesheet-log
bun add commit-to-timesheet-log
```

Provides the command `setup-commit-to-time-sheet`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-06-26 |
| First published | 2022-06-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | venkatas@geekyants.com |
| Maintainers | takasi-venkata-sandeep |
| Keywords | automate timesheet, git hooks |

## Links

- npm: https://www.npmjs.com/package/commit-to-timesheet-log
- npm.io page: https://npm.io/package/commit-to-timesheet-log

## Dependencies (2)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10

## Recent versions

- 1.0.4 (latest) — 2022-06-26
- 1.0.3 — 2022-06-26
- 1.0.2 — 2022-06-26
- 1.0.1 — 2022-06-26
- 1.0.0 — 2022-06-26

## README

# commit-to-timesheet-log

#### Automate your timesheet with git commits

Commit-to-timesheet-log is a npm package to modify the github hooks in your project to automate your timesheet updation based on your git commits.

## Installation

Install commit-to-timesheet-log globally.

## Usage

```sh
npm i -g commit-to-timesheet-log
```

Run the command "**setup-commit-to-time-sheet**" in the root level of your git project and enter your geekyants email.

```sh
setup-commit-to-time-sheet
```

Based on the email entered it will create a personalised commit-msg hook in .git/hooks folder of your project.

## commit syntax to log timesheet

```sh
git commit -am “[Log - {HRS}] [TICKET-ID: {JIRA_PROJECT_CODE-Ticket_ID}] : {COMMIT_MESSAGE}”
```

Example: git commit -am “[Log - 4] [TICKET-ID - EX-110] : Facebook login implemented”

The above example command will log your "**4 hours**" of work for today in GeekyAnts portal with the description as "**Facebook login implemented**".

## Assumptions

At this time the timesheet api is not available so i created a "[mock-timesheet-server](https://mock-timesheet-server.herokuapp.com/timesheet/api)" to mock the behaviour provided i.e

- Success response: {”success”: true, “errorMessage”: “”}
- Error response: {”success”: false, “errorMessage”: “User doesn’t exist”}

And currently "**venkatas@geekyants.com**" is the only whitelisted email and for other emails the api will respond with the Error response.

---
_Source: https://npm.io/package/commit-to-timesheet-log · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._