hashicorp / hashicorp/copywrite

YAML files with directives

Open
#30 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
120
Forks
22
Avg merge
1d 15h
Merged PRs (30d)
4

Description

This is probably more a stylistic thing but if you have a yaml file

```yaml
%YAML 1.2
# yaml-language-server: $schema=https://json.schemastore.org/pre-commit-config.json
---
default_install_hook_types:
- pre-commit
...
```

and update it with `copywrite headers` you end up with

```yaml
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

%YAML 1.2
# yaml-language-server: $schema=https://json.schemastore.org/pre-commit-config.json
---
default_install_hook_types:
- pre-commit
...
```

This contrasts with the behaviour of shell scripts which maintain the shebang as the first line.

I don't think it particularly matters for `TAG` directives but in the case of the `YAML` directive should this be handled similarly?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.