-
Notifications
You must be signed in to change notification settings - Fork 0
/
Plugin.js
73 lines (65 loc) · 2.29 KB
/
Plugin.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
*
* Copyright 2014-2019 David Herron
*
* This file is part of AkashaCMS (http://akashacms.com/).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
const _plugin_name = Symbol('name');
const _plugin_options = Symbol('options');
const _plugin_akasha = Symbol('akasha');
module.exports = class Plugin {
constructor(name) {
this[_plugin_name] = name;
}
set options(newOptions) { this[_plugin_options] = newOptions; }
get options() { return this[_plugin_options]; }
get akasha() { return this[_plugin_akasha]; }
set akasha(_akasha) { this[_plugin_akasha] = _akasha; }
/**
* Add this plugin to the configuration object.
*/
configure(config, options) {
throw new Error("Must implement configure function");
}
/**
* Getter for the plugin name
*/
get name() { return this[_plugin_name]; }
/**
* Getter for object describing the additional FileCache fields
* to index. Plugins may be interested in specific data that must
* be indexed.
*
* This function returns an empty object. Any plugin wishing to
* have an indexed field should implement this, and modify this object
* appropriately.
*
* The object returned has four fields, <code>documents</code>,
* <code>assets</code>, <code>layouts</code>, and <code>partials</code>.
*
* Any field that is <code>undefined</code> is to be ignored. Otherwise
* the field must be an object listing the fields to index. This
* mechanism does not support setting the index type.
*/
get cacheIndexes() {
return {
documents: undefined, // {},
assets: undefined, // {},
layouts: undefined, // {},
partials: undefined, // {}
};
}
};