search

new-xkit / XKit

Fork of XKit, the extension framework for Tumblr
https://new-xkit-extension.tumblr.com
Other
459 stars 135 forks source link

Deprecate Legacy Headers #479

Open 0xazure opened 9 years ago

0xazure commented 9 years ago

In conjunction with #478, I would propose the depreciation of Legacy Headers in favour of proper programmatic export of these values. In essence, we would change the existing comment block, like below:

//* TITLE Extension Title **//
//* VERSION 1.0.0 **//
//* DESCRIPTION A short description **//
//* DETAILS A much longer description should go here. **//
//* DEVELOPER new-xkit **//
//* FRAME false **//
//* BETA false **//

and convert it into CommonJS module exports, for example:

var meta = {
  title: "Extension Title",
  version: "1.0.0",
  description: "A short description.",
  details: "A much longer description should go here.",
  developer: "new-xkit",
  frame: false,
  beta: false,
  slow: false
};

module.exports.meta = Object.freeze(meta);
Wolvan commented 9 years ago

:+1:

bvtsang commented 9 years ago

We'll also need to update the following wiki pages:

Wolvan commented 9 years ago

First we have to phase the old headers out, @bvtsang

bvtsang commented 9 years ago

Right, I'm just mentioning the wiki pages because we'll need to make sure the deprecation of the headers is consistent with the information we have on the wikis. We don't want people getting conflicting information.

Also, mentioning the wiki stuff here helps us track it.