https://github.com/tumido/cron-explained

https://github.com/tumido/cron-explained

vscode-extension

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tumido/cron-explained
• Owner: tumido
• License: gpl-3.0
• Created: 2020-11-30T17:06:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-26T22:17:33.000Z (4 months ago)
• Last Synced: 2024-10-27T06:55:37.519Z (4 months ago)
• Topics: vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=tumido.cron-explained
• Size: 2.55 MB
• Stars: 13
• Watchers: 3
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
![logo](https://raw.githubusercontent.com/tumido/cron-explained/master/docs/assets/icon_large.png)

# Cron Explained

[![](https://img.shields.io/github/v/release/tumido/cron-explained)](https://github.com/tumido/cron-explained/releases)

[![](https://img.shields.io/visual-studio-marketplace/v/tumido.cron-explained?label=vs%20marketplace)](https://marketplace.visualstudio.com/items?itemName=tumido.cron-explained)

[![](https://img.shields.io/open-vsx/v/tumido/cron-explained)](https://open-vsx.org/extension/tumido/cron-explained)

[![](https://img.shields.io/github/license/tumido/cron-explained)](https://github.com/tumido/cron-explained/blob/master/LICENSE)

[![](https://img.shields.io/github/workflow/status/tumido/cron-explained/Release)](https://github.com/tumido/cron-explained/actions?query=workflow%3ARelease)

Have you ever found the cron format confusing? Did you ever need to know what is the "real" schedule? Are you tired of copy pasting the `"2,3,4 */2 * * 4"` into other online tools? This extension might come handy to you.

## Features

### Hover tooltips

When hovering over cron-like schedules, display a human friendly explanation in a tooltip.

![hover](https://raw.githubusercontent.com/tumido/cron-explained/master/docs/assets/hover.gif)

### Code lens

Show code lens action to make inserting explanation as comment easier.

![code-lens](https://raw.githubusercontent.com/tumido/cron-explained/master/docs/assets/code-lens.gif)

### Save as comment

Command allowing you add an inline comment with the explanation.

![comment](https://raw.githubusercontent.com/tumido/cron-explained/master/docs/assets/comment.gif)

## Extension Settings

This extension contributes the following settings:

| Settings                                                  | Description                                                                                                                                                    | Default value        |

| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |

| `cron-explained.hover.enabled`                            | When enabled, the transcript is shown in a hover tooltip.                                                                                                      | `true`               |

| `cron-explained.codeLens.enabled`                         | When enabled, the transcript is shown as a code lens.                                                                                                          | `false`              |

| `cron-explained.codeLens.showTranscript`                  | Show the transcript of a cron string in a code lens.                                                                                                           | `true`               |

| `cron-explained.codeLens.showCommentAction`               | Show action to insert comment for a cron string.                                                                                                               | `true`               |

| `cron-explained.cronstrueOptions.use24HourTimeFormat`     | If set, descriptions will use a 24-hour clock.                                                                                                                 | `true`               |

| `cron-explained.cronstrueOptions.verbose`                 | Whether to use a verbose description.                                                                                                                          | `true`               |

| `cron-explained.cronstrueOptions.locale`                  | Enforce specific language for transcriptions.                                                                                                                  | Environment language |

| `cron-explained.cronstrueOptions.dayOfWeekStartIndexZero` | Whether to interpret cron expression day of week '1' as Sunday (`false`) or Monday (`true`).\n\n_(For example: AWS uses 1 as Sunday -> set option to `false`)_ | `true`               |

| `cron-explained.cronstrueOptions.monthStartIndexZero`     | Whether to interpret January as '0' or '1'                                                                                                                     | `true`               |

## Credit

1. [unDraw](https://undraw.co) for wonderful art.

2. [`cronstrue`](https://www.npmjs.com/package/cronstrue) which provides the cron translations.