Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Add support for additional file formats #11

Open
bric3 opened this issue Jun 23, 2023 · 2 comments
Open

Add support for additional file formats #11

bric3 opened this issue Jun 23, 2023 · 2 comments

Comments

@bric3
Copy link

bric3 commented Jun 23, 2023

I think supporting TOML, properties, XML, YAML would be really useful. Basically these file have two types of comments

  • Prefixed by #
  • XMLs are special as the comment as to be surrounded by <!-- / -->, but must happen after <?xml version="1.0" standalone="no"?>

I don't know about other file types, but leaving the ability to declare them might like licensesnip might help support them without too much work.

{
  "use_gitignore": true,
  "file_types": {
    "js,mjs,ts,cjs,jsx,tsx": {
      "before_line": "// "
    },
    "vue,html": {
      "before_block": "<!--",
      "before_line": "  ",
      "after_block": "-->"
    },
    "rs": {
      "before_line": "// "
    },
    "c": {
      "enable": false
    }
  }
}
@LambdAurora
Copy link
Contributor

The given file types are often used for configuration, right now I don't really see any interest in licensing configuration files?

If I can be given a more precise use case that'd be nice.

@bric3
Copy link
Author

bric3 commented Jun 23, 2023

I think if configuration files are needed to make the software work, most licenses consider them as source code.

More over they are a few tools that work with configuration as code, in this case the configuration file is also considered source code. Typically CI pipelines.

And I think that if a project finds a solution to drive a software via such configuration file, this has to be protected by license.

I am not a lawyer, but big project tend to apply the notice header on such files as well.
E.g. the JDK :

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants