Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

License shows None in NPM #43

Open
lisandi opened this issue Oct 3, 2021 · 5 comments
Open

License shows None in NPM #43

lisandi opened this issue Oct 3, 2021 · 5 comments

Comments

@lisandi
Copy link
Contributor

lisandi commented Oct 3, 2021

In NPM no license shows up in the right column under License
Screen Shot 2021-10-03 at 10 07 07
and in main text it says something had been copied over from headings
Screen Shot 2021-10-03 at 10 07 38
I would suggest adding the license like it is available on github.

@JohnMcLear
Copy link
Member

Can you please send this as a pull request? I assume the line is missing in package.json

@lisandi
Copy link
Contributor Author

lisandi commented Oct 3, 2021

The problem with the missing licenses is a home-made problem because in the demo package.json important entries you want to see are filled out by developers are simply missing. I suggest that you all agree in ONE structure and order of that package json file - which will make it much easier to find/edit missing entries and that this "FULL FEATURE" demo structure of the package.json file then gets posted in the Manual/Tutorial/Wiki.

The following is the current demo: https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin

{
  "name": "ep_PLUGINNAME",
  "version": "0.0.1",
  "description": "DESCRIPTION",
  "author": "USERNAME (REAL NAME) <[email protected]>",
  "contributors": [],
  "dependencies": {"MODULE": "0.3.20"},
  "peerDependencies": {"ep_etherpad_lite":">=1.5.1"},
  "engines": { "node": ">= 0.6.0"}
}

no license is available here and perhaps also other parts are missing.
This might be true also for a whole lot of other demo structures posted on demo sites that lack parts you actually want to see. Adding those in the demos will help to keep things much more consistent.

i.e.

{
  "name": "ep_PLUGINNAME",
  "version": "0.0.1",
  "description": "DESCRIPTION",
  "author": {
    "name": "USERNAME (REAL NAME)",
    "email":  "<[email protected]>",
  },  
  "contributors": [
   "CONTRIBUTORNAME (REAL NAME)",
    "url": "https://github.com/ether/myplugin/CONTRIBUTING.md",
  ],  
  "keywords": [
    "etherpad",
    "plugin",
    "ep",
  ], 
"license": {
  "Apache2",
  "url": "https://github.com/ether/myplugin/LICENSE.md",
} 
 "repository": {
    "type": "git",
    "url": "https://github.com/ether/myplugin.git",
  },
  "bugs": {
    "url": "https://github.com/ether/myplugin/issues",
  },
  "homepage": {
    "url": "https://github.com/ether/myplugin/README.md",
  },
  "funding": {
    "type": "individual",
    "url": "https://etherpad.org/",
  },
  "dependencies": {
    "MODULE": "0.3.20",
  }, 
  "peerDependencies": {
    "ep_etherpad_lite":">=1.8.6",
  }, 
  "devDependencies": {
    "eslint": "^7.18.0",
    "eslint-config-etherpad": "^1.0.24",
    "eslint-plugin-eslint-comments": "^3.2.0",
    "eslint-plugin-mocha": "^8.0.0",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-prefer-arrow": "^1.2.3",
    "eslint-plugin-promise": "^4.2.1",
    "eslint-plugin-you-dont-need-lodash-underscore": "^6.10.0",
  },
    "eslintConfig": {
    "root": true,
    "extends": "etherpad/plugin",
  },
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint --fix .",
  },
  "engines": { 
    "node": ">= 10.13.0",
  }
}

Having a clear already formatted structure available helps to keep those package.json files consistent and developers could at the next update they do simply adjust the package.json to that requirement. They could enter also their own funding pages and of course the github repository or gitlab etc. where they have the files visible.

I would discuss that with the other developers as still the plugin number is below 200 and over 50% are duplicates or anyway not working at all. Next you could run an automated check if all those files like license, readme etc are available.

@JohnMcLear
Copy link
Member

Please feel free to modify https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin to include a license! It's a wiki so anyone can do it afaik.

Also see checkPlugins.js. I wrote about it here: https://mclear.co.uk/2020/07/18/suggestions-for-improving-etherpad-plugins/

@lisandi
Copy link
Contributor Author

lisandi commented Oct 3, 2021

I changed it. please look through if OK like that! https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin

@JohnMcLear
Copy link
Member

Formatting is a little bit off, the license part needs indenting

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

No branches or pull requests

2 participants