Add package.json support for Themes #2081

Closed
ErisDS opened this Issue Jan 30, 2014 · 1 comment

Comments

Projects
None yet
2 participants
@ErisDS
Member

ErisDS commented Jan 30, 2014

Require tree already reads all of the contents of a theme directory, but we want to add support for reading the contents of a package.json file.

On the settings page, if a theme does have a package.json file, we should read the name and version number and use these in the dropdown like:

themes

If there is no package.json file, we should use the directory name as before.

Also if a theme does not have a package.json file output a warning on the console explaining that themes should have package.json files, and a link to a page explaining what's going on. The URL for that page is TBD.

It is worth considering how and where we load the data from the package.json file probably at the same time as doing the requireTree - and also when to output the warning - at start when the directory is loaded? When the theme is activated? I'd recommend both.

Note: This is a temporary improvement to introduce package.json files. Long term we will add support for more information via a much better UI.

Also note: When implementing this, consider that apps, which are not currently used in the UI anywhere, will also need to have package.json files which are loaded.

@javorszky

This comment has been minimized.

Show comment
Hide comment
@javorszky

javorszky Jan 30, 2014

Member

dibs :)

Member

javorszky commented Jan 30, 2014

dibs :)

@ghost ghost assigned javorszky Jan 30, 2014

@jamesramsay jamesramsay referenced this issue in jamesramsay/ghost-incorporated Feb 6, 2014

Open

Add package.json #10

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 8, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package` key. Caveat: any other file / directory with extension other than .json will likely break this behaviour
* settings api populates theme data package if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 8, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 8, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 8, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 8, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 12, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.
* Added error and warning messages for package.json file parse errors and misses

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 12, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.
* Added error and warning messages for package.json file parse errors and misses

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 13, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.
* Added error and warning messages for package.json file parse errors and misses

javorszky added a commit to javorszky/Ghost that referenced this issue Feb 13, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.
* Added error and warning messages for package.json file parse errors and misses

@ErisDS ErisDS closed this in #2156 Feb 16, 2014

@ErisDS ErisDS modified the milestones: 0.4.2, 0.5 Mar 10, 2014

morficus pushed a commit to morficus/Ghost that referenced this issue Sep 4, 2014

Added package.js support for themes (and plugins)
Closes #2081
* Amended require-tree to populate availableThemes and availablePlugins to use full file names (`basename.ext`) as keys instead of just basename. This way `image.jpg`, `image.png`, `image.gif` won't overwrite the `image` key.
* Amended require-tree to allow package.json file parsing to return the contents of the file as json on the `package.json` key.
* settings api populates theme data `package` if it exists. Otherwise it assigns `false` to it
* `general.hbs` (salute) was reworked to if there is the package key on the theme is not false, it will use the `name` and `version` keys of that. You can break it by not having a `name` or `version` in the package.json file.
* Added error and warning messages for package.json file parse errors and misses
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment