Coder Social home page Coder Social logo

Cleanup file headers about magicmirror HOT 7 CLOSED

khassel avatar khassel commented on June 12, 2024 1
Cleanup file headers

from magicmirror.

Comments (7)

khassel avatar khassel commented on June 12, 2024 1

For the author headers: find ./ -type f -exec sed -i -r '/^\s\* By.*$/d' {} \;

from magicmirror.

rejas avatar rejas commented on June 12, 2024 1

so I guess this is done and can be closed @khassel ?

from magicmirror.

KristjanESPERANTO avatar KristjanESPERANTO commented on June 12, 2024

In my understanding of MIT, it is not necessary to mention the license in all files. But I think it's fine to do it.

As a basis for discussion, here is the current header from app.js:

   /* MagicMirror²
   * The Core App (Server)
   *
   * By Michael Teeuw https://michaelteeuw.nl
   * MIT Licensed.
   */

And here three spontaneous proposals:

Proposal 1:
author line removed + asterisk below each other

  /*
   * MagicMirror²
   * The Core App (Server)
   *
   * MIT Licensed.
   */

Proposal 2:
author line removed + license note formulated in more detail + asterisk below each other

 /*
  * MagicMirror²
  * The Core App (Server)
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */

Proposal 3:
author line and license note removed + asterisk below each other

 /*
  * MagicMirror²
  * The Core App (Server)
  */

Feel free to tear these proposals apart. The license part in proposal 2 I found in the sources of react.

from magicmirror.

KristjanESPERANTO avatar KristjanESPERANTO commented on June 12, 2024

There are even a few ESLint plugins that check the headers. Here is the rule of one of them that seems suitable: https://github.com/nikku/eslint-plugin-license-header/blob/master/docs/rules/header.md

The example there looks very similar to proposal 2.

  /**
   * Copyright (c) Foo Corp.
   *
   * This source code is licensed under the WTFPL license found in the
   * LICENSE file in the root of this projects source tree.
   */

Edit: But with the ESLint plugin approach, I now see the downside that the headers have to be the same everywhere... Additions like "The Core App (Server)" couldn't be in that block.

from magicmirror.

rejas avatar rejas commented on June 12, 2024

Proposal 4: Remove headers alltogether. They provide no real information. I would rather have proper jsdoc headers everywhere ;-)

from magicmirror.

khassel avatar khassel commented on June 12, 2024

from my side we can remove all these headers ...

from magicmirror.

KristjanESPERANTO avatar KristjanESPERANTO commented on June 12, 2024

I'm also fine with removing 👍

from magicmirror.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.