https://github.com/arjunkomath/js-file-header-vscode

VS Code Extension: JavaScript File Header for Documentation
https://github.com/arjunkomath/js-file-header-vscode

Last synced: 3 months ago
JSON representation

VS Code Extension: JavaScript File Header for Documentation

• Host: GitHub
• URL: https://github.com/arjunkomath/js-file-header-vscode
• Owner: arjunkomath
• Created: 2017-11-02T21:00:44.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T18:32:34.000Z (about 2 years ago)
• Last Synced: 2024-08-03T09:08:29.177Z (7 months ago)
• Language: JavaScript
• Size: 983 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-github-star - js-file-header-vscode

README

        
# JavaScript File Header extension

[![Badge for version for Visual Studio Code extension arjunkomath.js-file-header](https://vsmarketplacebadge.apphb.com/version/arjunkomath.js-file-header.svg)](https://marketplace.visualstudio.com/items?itemName=arjunkomath.js-file-header)

[![Badge for installs for Visual Studio Code extension arjunkomath.js-file-header](https://vsmarketplacebadge.apphb.com/installs/naereen.arjunkomath.js-file-header.svg)](https://marketplace.visualstudio.com/items?itemName=arjunkomath.js-file-header)

[![Badge for rating for Visual Studio Code extension arjunkomath.js-file-header](https://vsmarketplacebadge.apphb.com/rating/naereen.arjunkomath.js-file-header.svg)](https://marketplace.visualstudio.com/items?itemName=arjunkomath.js-file-header)

[![made-for-VSCode](https://img.shields.io/badge/Made%20for-VSCode-1f425f.svg)](https://code.visualstudio.com/)

![Demo](https://github.com/arjunkomath/js-file-header-vscode/blob/24e8a8d8441914ac4eb1fe0fd308a9820214b2f7/demo.gif)

## Usage

When any JS file is open you can use the keyboard shortcut `alt + cmd + H` or `alt + crtl + H` to add file header. \

You can also select `JavaScript : Add File Header option` from command palette to do the same.

## Features

- Create a file documentation header

- Last modified time is updated automatically

```javascript

/**

 * Copyright (c) 2017

 *

 * long description for the file

 *

 * @summary short description for the file

 * @author Arjun 

 *

 * Created at     : 2017-11-03 02:21:56 

 * Last modified  : 2018-02-25 15:31:40

 */

```

## Extension Settings

This extension contributes the following settings:

* `jsFileHeader.Author`: Author name and email

* `jsFileHeader.Copyright`: Copyright information

* `jsFileHeader.License`: License information

## Release Notes

### 0.1.3

- Start extention on opening javascript files

- Add icon and repo url

- Update release notes

### 0.0.1

- Initial release

-----------------------------------------------------------------------------------------------------------

**Enjoy!**