6 |
7 | ## Usage
8 |
9 | You can download the latest version on the [releases](https://github.com/cerebroapp/cerebro/releases) page.
10 |
11 | - If there isn't an installer for your OS, check [build instructions](#build-executable-from-source).
12 | - If you are a linux user see [how to install the executable](#install-executable-on-linux)
13 |
14 | After the installation, use the default shortcut, `ctrl+space`, to show the app window. You can customize this shortcut by clicking on the icon in the menu bar, and then selecting "Preferences...".
15 |
16 | 
17 |
18 | ### Plugins
19 |
20 | ### Core plugins
21 |
22 | - Search the web with your favourite search engine
23 | - Search & launch application, i.e. `spotify`
24 | - Navigate the file system with file previews (i.e. `~/Dropbox/passport.pdf`)
25 | - Calculator
26 | - Smart converter. `15$`, `150 рублей в евро`, `100 eur in gbp`;
27 |
28 | ### Install plugins
29 |
30 | You can manage and install more plugins by typing `plugins {autocompleteTerm}
104 | : null
105 | }
106 |
107 | Autocomplete.propTypes = {
108 | autocompleteCalculator: PropTypes.func.isRequired,
109 | }
110 |
111 | /**
112 | * Main search container
113 | *
114 | * TODO: Remove redux
115 | * TODO: Split to more components
116 | */
117 | function Cerebro({
118 | results, selected, visibleResults, actions, term, prevTerm, statusBarText
119 | }) {
120 | const mainInput = useRef(null)
121 | const [mainInputFocused, setMainInputFocused] = useState(false)
122 | const [prevResultsLenght, setPrevResultsLenght] = useState(() => results.length)
123 |
124 | const focusMainInput = () => {
125 | mainInput.current.focus()
126 | if (config.get('selectOnShow')) {
127 | mainInput.current.select()
128 | }
129 | }
130 |
131 | // suscribe to events
132 | useEffect(() => {
133 | focusMainInput()
134 | updateElectronWindow(results, visibleResults)
135 | // Listen for window.resize and change default space for results to user's value
136 | window.addEventListener('resize', onWindowResize)
137 | // Add some global key handlers
138 | window.addEventListener('keydown', onDocumentKeydown)
139 | // Cleanup event listeners on unload
140 | // NOTE: when page refreshed (location.reload) componentWillUnmount is not called
141 | window.addEventListener('beforeunload', cleanup)
142 | electronWindow.on('show', focusMainInput)
143 | electronWindow.on('show', () => updateElectronWindow(results, visibleResults))
144 |
145 | // function to be called when unmounted
146 | return () => {
147 | cleanup()
148 | }
149 | }, [])
150 |
151 | if (results.length !== prevResultsLenght) {
152 | // Resize electron window when results count changed
153 | updateElectronWindow(results, visibleResults)
154 | setPrevResultsLenght(results.length)
155 | }
156 |
157 | /**
158 | * Handle resize window and change count of visible results depends on window size
159 | */
160 | const onWindowResize = () => {
161 | if (results.length <= MIN_VISIBLE_RESULTS) return false
162 |
163 | let maxVisibleResults = Math.floor((window.outerHeight - INPUT_HEIGHT) / RESULT_HEIGHT)
164 | maxVisibleResults = Math.max(MIN_VISIBLE_RESULTS, maxVisibleResults)
165 | if (maxVisibleResults !== visibleResults) {
166 | actions.changeVisibleResults(maxVisibleResults)
167 | }
168 | }
169 |
170 | /**
171 | * Handle keyboard shortcuts
172 | */
173 | const onKeyDown = (event) => {
174 | const highlighted = highlightedResult()
175 | // TODO: go to first result on cmd+up and last result on cmd+down
176 | if (highlighted && highlighted.onKeyDown) highlighted.onKeyDown(event)
177 |
178 | if (event.defaultPrevented) { return }
179 |
180 | const keyActions = {
181 | select: () => selectCurrent(event),
182 |
183 | arrowRight: () => {
184 | if (cursorInEndOfInut(event.target)) {
185 | if (autocompleteValue()) {
186 | // Autocomplete by arrow right only if autocomple value is shown
187 | autocomplete(event)
188 | } else {
189 | focusPreview()
190 | event.preventDefault()
191 | }
192 | }
193 | },
194 |
195 | arrowDown: () => {
196 | actions.moveCursor(1)
197 | event.preventDefault()
198 | },
199 |
200 | arrowUp: () => {
201 | if (results.length > 0) {
202 | actions.moveCursor(-1)
203 | } else if (prevTerm) {
204 | actions.updateTerm(prevTerm)
205 | }
206 | event.preventDefault()
207 | }
208 | }
209 |
210 | // shortcuts for ctrl+...
211 | if ((event.metaKey || event.ctrlKey) && !event.altKey) {
212 | // Copy to clipboard on cmd+c
213 | if (event.keyCode === 67) {
214 | const text = highlightedResult()?.clipboard || term
215 | if (text) {
216 | clipboard.writeText(text)
217 | actions.reset()
218 | if (!event.defaultPrevented) {
219 | electronWindow.hide()
220 | }
221 | event.preventDefault()
222 | }
223 | return
224 | }
225 |
226 | // Select text on cmd+a
227 | if (event.keyCode === 65) {
228 | mainInput.current.select()
229 | event.preventDefault()
230 | }
231 |
232 | // Select element by number
233 | if (event.keyCode >= 49 && event.keyCode <= 57) {
234 | const number = Math.abs(49 - event.keyCode)
235 | const result = results[number]
236 |
237 | if (result) return selectItem(result, event)
238 | }
239 |
240 | // Lightweight vim-mode: cmd/ctrl + jklo
241 | switch (event.keyCode) {
242 | case 74:
243 | keyActions.arrowDown()
244 | break
245 | case 75:
246 | keyActions.arrowUp()
247 | break
248 | case 76:
249 | keyActions.arrowRight()
250 | break
251 | case 79:
252 | keyActions.select()
253 | break
254 | }
255 | }
256 |
257 | switch (event.keyCode) {
258 | case 9:
259 | autocomplete(event)
260 | break
261 | case 39:
262 | keyActions.arrowRight()
263 | break
264 | case 40:
265 | keyActions.arrowDown()
266 | break
267 | case 38:
268 | keyActions.arrowUp()
269 | break
270 | case 13:
271 | keyActions.select()
272 | break
273 | case 27:
274 | actions.reset()
275 | electronWindow.hide()
276 | break
277 | }
278 | }
279 |
280 | const onMainInputFocus = () => setMainInputFocused(true)
281 | const onMainInputBlur = () => setMainInputFocused(false)
282 |
283 | const cleanup = () => {
284 | window.removeEventListener('resize', onWindowResize)
285 | window.removeEventListener('keydown', onDocumentKeydown)
286 | window.removeEventListener('beforeunload', cleanup)
287 | electronWindow.removeAllListeners('show')
288 | }
289 |
290 | /**
291 | * Get highlighted result
292 | * @return {Object}
293 | */
294 | const highlightedResult = () => results[selected]
295 |
296 | /**
297 | * Select item from results list
298 | * @param {[type]} item [description]
299 | * @return {[type]} [description]
300 | */
301 | const selectItem = (item, realEvent) => {
302 | actions.reset()
303 | const event = wrapEvent(realEvent)
304 | item.onSelect(event)
305 |
306 | if (!event.defaultPrevented) electronWindow.hide()
307 | }
308 |
309 | /**
310 | * Autocomple search term from highlighted result
311 | */
312 | const autocomplete = (event) => {
313 | const { term: highlightedTerm } = highlightedResult()
314 | if (highlightedTerm && highlightedTerm !== term) {
315 | actions.updateTerm(highlightedTerm)
316 | event.preventDefault()
317 | }
318 | }
319 |
320 | /**
321 | * Select highlighted element
322 | */
323 | const selectCurrent = (event) => selectItem(highlightedResult(), event)
324 |
325 | const autocompleteValue = () => {
326 | const selectedResult = highlightedResult()
327 | if (selectedResult && selectedResult.term) {
328 | const regexp = new RegExp(`^${escapeStringRegexp(term)}`, 'i')
329 | if (selectedResult.term.match(regexp)) {
330 | return selectedResult.term.replace(regexp, term)
331 | }
332 | }
333 | return ''
334 | }
335 |
336 | return (
337 |
338 |
363 | )
364 | }
365 |
366 | Cerebro.propTypes = {
367 | actions: PropTypes.shape({
368 | reset: PropTypes.func,
369 | moveCursor: PropTypes.func,
370 | updateTerm: PropTypes.func,
371 | changeVisibleResults: PropTypes.func,
372 | selectElement: PropTypes.func,
373 | }),
374 | results: PropTypes.array,
375 | selected: PropTypes.number,
376 | visibleResults: PropTypes.number,
377 | term: PropTypes.string,
378 | statusBarText: PropTypes.string,
379 | prevTerm: PropTypes.string,
380 | }
381 |
382 | function mapStateToProps(state) {
383 | return {
384 | selected: state.search.selected,
385 | results: state.search.resultIds.map((id) => state.search.resultsById[id]),
386 | term: state.search.term,
387 | statusBarText: state.statusBar.text,
388 | prevTerm: state.search.prevTerm,
389 | visibleResults: state.search.visibleResults,
390 | }
391 | }
392 |
393 | function mapDispatchToProps(dispatch) {
394 | return {
395 | actions: bindActionCreators(searchActions, dispatch),
396 | }
397 | }
398 |
399 | export default connect(mapStateToProps, mapDispatchToProps)(Cerebro)
400 |
--------------------------------------------------------------------------------
/app/main/components/Cerebro/styles.module.css:
--------------------------------------------------------------------------------
1 | .search {
2 | position: relative;
3 | display: flex;
4 | flex-direction: column;
5 | height: 100%;
6 | }
7 |
8 | .inputWrapper {
9 | position: relative;
10 | z-index: 2;
11 | width: 100%;
12 | height: 45px;
13 | }
14 |
15 | .autocomplete {
16 | position: absolute;
17 | z-index: 1;
18 | width: 100%;
19 | height: 45px;
20 | font-size: 1.5em;
21 | padding: 0 10px;
22 | line-height: 46px;
23 | box-sizing: border-box;
24 | color: var(--secondary-font-color);
25 | white-space: pre;
26 | }
27 |
28 | ::-webkit-scrollbar {
29 | height: var(--scroll-height);
30 | width: var(--scroll-width);
31 | background: var(--scroll-background);
32 | -webkit-border-radius: 0;
33 | }
34 |
35 | ::-webkit-scrollbar-track {
36 | background: var(--scroll-track);
37 | }
38 | ::-webkit-scrollbar-track:active {
39 | background: var(--scroll-track-active);
40 | }
41 |
42 | ::-webkit-scrollbar-track:hover {
43 | background: var(--scroll-track-hover);
44 | }
45 |
46 | ::-webkit-scrollbar-thumb {
47 | background: var(--scroll-thumb);
48 | -webkit-border-radius: 3px;
49 | }
50 |
51 | ::-webkit-scrollbar-thumb:hover {
52 | background: var(--scroll-thumb-hover);
53 | }
54 |
55 | ::-webkit-scrollbar-thumb:active {
56 | background: var(--scroll-thumb-active);
57 | }
58 |
59 | ::-webkit-scrollbar-thumb:vertical {
60 | min-height: 10px;
61 | }
62 |
63 | ::-webkit-scrollbar-thumb:horizontal {
64 | min-width: 10px;
65 | }
66 |
67 | .input {
68 | width: 100%;
69 | height: 45px;
70 | color: var(--main-font-color);
71 | font-family: var(--main-font);
72 | font-size: 1.5em;
73 | border: 0;
74 | outline: none;
75 | padding: 0 10px;
76 | line-height: 60px;
77 | box-sizing: border-box;
78 | background: transparent;
79 | white-space: nowrap;
80 | -webkit-app-region: drag;
81 | -webkit-user-select: none;
82 | }
83 |
--------------------------------------------------------------------------------
/app/main/components/ResultsList/Row/index.tsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import SmartIcon from '../../SmartIcon'
3 |
4 | // @ts-ignore
5 | import styles from './styles.module.css'
6 |
7 | interface RowProps {
8 | style?: any
9 | title?: string
10 | icon?: string
11 | selected?: boolean
12 | subtitle?: string
13 | onSelect?: () => void
14 | onMouseMove?: () => void
15 | }
16 |
17 | function Row({
18 | selected, icon, title, onSelect, onMouseMove, subtitle, style
19 | }: RowProps) {
20 | const classNames = [styles.row, selected ? styles.selected : null].join(' ')
21 |
22 | return (
23 |
340 | actions.updateTerm(e.target.value)}
348 | onKeyDown={onKeyDown}
349 | onFocus={onMainInputFocus}
350 | onBlur={onMainInputBlur}
351 | />
352 |
353 | {}}
29 | >
30 | {icon &&
38 | )
39 | }
40 |
41 | export default Row
42 |
--------------------------------------------------------------------------------
/app/main/components/ResultsList/Row/styles.module.css:
--------------------------------------------------------------------------------
1 | /**
2 | * TODO: colors should be moved to variables
3 | */
4 | .row {
5 | position: relative;
6 | display: flex;
7 | flex-wrap: nowrap;
8 | flex-direction: row;
9 | align-items: flex-start;
10 | white-space: nowrap;
11 | width: 100%;
12 | cursor: pointer;
13 | box-sizing: border-box;
14 | height: 45px;
15 | padding: 3px 5px;
16 | align-items: center;
17 | color: var(--main-font-color);
18 | background: var(--result-background);
19 | }
20 |
21 | .icon {
22 | max-height: 30px;
23 | max-width: 30px;
24 | margin-right: 5px;
25 | }
26 |
27 | .title {
28 | font-size: .8em;
29 | max-width: 100%;
30 | /* overflow-x: hidden; */
31 | color: var(--result-title-color);
32 | }
33 |
34 |
35 | .subtitle {
36 | font-size: 0.8em;
37 | font-weight: 300;
38 | color: var(--result-subtitle-color);
39 | max-width: 100%;
40 | /* overflow-x: hidden; */
41 | }
42 |
43 | .selected {
44 | background: var(--selected-result-background);
45 | .title {
46 | color: var(--selected-result-title-color);
47 | }
48 | .subtitle {
49 | color: var(--selected-result-subtitle-color);
50 | }
51 | }
52 |
53 | .details {
54 | position: relative;
55 | display: flex;
56 | flex-grow: 2;
57 | flex-wrap: wrap;
58 | flex-direction: column;
59 | align-items: flex-start;
60 | justify-content: center;
61 | height: 90%;
62 | }
63 |
--------------------------------------------------------------------------------
/app/main/components/ResultsList/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import PropTypes from 'prop-types'
3 | import { List } from 'react-virtualized'
4 | import { RESULT_HEIGHT } from 'main/constants/ui'
5 |
6 | import Row from './Row'
7 | import styles from './styles.module.css'
8 |
9 | function ResultsList({
10 | results, selected, visibleResults, onSelect, mainInputFocused, onItemHover
11 | }) {
12 | const rowRenderer = ({ index, key, style }) => {
13 | const result = results[index]
14 | const attrs = {
15 | ...result,
16 | // TODO: think about events
17 | // In some cases action should be executed and window should be closed
18 | // In some cases we should autocomplete value
19 | selected: index === selected,
20 | onSelect: (event) => onSelect(result, event),
21 | // Move selection to item under cursor
22 | onMouseMove: (event) => {
23 | const { movementX, movementY } = event.nativeEvent
24 | if (index === selected || !mainInputFocused) return false
25 |
26 | if (movementX || movementY) {
27 | // Hover item only when we had real movement of mouse
28 | // We should prevent changing of selection when user uses keyboard
29 | onItemHover(index)
30 | }
31 | },
32 | }
33 | return
33 | {title &&
37 | {title}
}
34 |
35 | {subtitle && {subtitle}
}
36 |
54 |
70 | )
71 | }
72 |
73 | ResultsList.propTypes = {
74 | results: PropTypes.array,
75 | selected: PropTypes.number,
76 | visibleResults: PropTypes.number,
77 | onItemHover: PropTypes.func,
78 | onSelect: PropTypes.func,
79 | mainInputFocused: PropTypes.bool,
80 | }
81 |
82 | export default ResultsList
83 |
--------------------------------------------------------------------------------
/app/main/components/ResultsList/styles.module.css:
--------------------------------------------------------------------------------
1 | .wrapper {
2 | display: flex;
3 | flex-direction: row;
4 | flex-wrap: nowrap;
5 | border-top: var(--main-border);
6 | height: 100%;
7 | position: relative;
8 | }
9 |
10 | .unfocused {
11 | opacity: .5;
12 | }
13 |
14 | .resultsList {
15 | overflow-y: auto;
16 | width: 100%;
17 | min-width: 250px;
18 | }
19 |
20 | .preview {
21 | flex-grow: 2;
22 | padding: 10px 10px 20px 10px;
23 | background-color: var(--main-background-color);
24 | align-items: center;
25 | display: flex;
26 | max-height: 100%;
27 | position: absolute;
28 | left: 250px;
29 | top: 0;
30 | bottom: 0;
31 | right: 0;
32 | overflow: auto;
33 | /*
34 | Instead of using `justify-content: center` we have to use this hack.
35 | In this case child element that is bigger than `.preview ` will be placed on left border
36 | instead of moving outside of container
37 | */
38 | &::before, &::after {
39 | content: '';
40 | margin: auto;
41 | }
42 |
43 | &:empty {
44 | display: none;
45 | }
46 |
47 | input {
48 | border: var(--preview-input-border);
49 | background: var(--preview-input-background);
50 | color: var(--preview-input-color);
51 | }
52 |
53 | :global {
54 | /* Styles for react-select */
55 | .Select {
56 | .Select-control {
57 | border: var(--preview-input-border);
58 | background: var(--preview-input-background);
59 | color: var(--preview-input-color);
60 | }
61 | .Select-menu-outer {
62 | border: var(--preview-input-border);
63 | background: var(--preview-input-background);
64 | }
65 | .Select-input input {
66 | border: 0;
67 | }
68 | .Select-value-label {
69 | color: var(--preview-input-color) !important;
70 | }
71 | .Select-option {
72 | background: var(--preview-input-background);
73 | color: var(--preview-input-color);
74 | &.is-selected {
75 | color: var(--selected-result-title-color);
76 | background: var(--selected-result-background);
77 | }
78 | &.is-focused {
79 | color: var(--selected-result-title-color);
80 | background: var(--selected-result-background);
81 | filter: opacity(50%);
82 | }
83 | }
84 | .Select-option.is-selected {
85 | }
86 | }
87 | }
88 | }
89 |
--------------------------------------------------------------------------------
/app/main/components/SmartIcon/getFileIcon/index.ts:
--------------------------------------------------------------------------------
1 | const { memoize } = require('cerebro-tools')
2 |
3 | const empty = () => Promise.reject()
4 |
5 | /* eslint-disable global-require */
6 | /* eslint-disable import/no-mutable-exports */
7 |
8 | let getFileIcon = empty
9 |
10 | if (process.platform === 'darwin') {
11 | getFileIcon = require('./mac')
12 | }
13 |
14 | if (process.platform === 'win32') {
15 | getFileIcon = require('./windows')
16 | }
17 |
18 | module.exports = memoize(getFileIcon)
19 |
20 | /* eslint-enable global-require */
21 | /* eslint-disable import/no-mutable-exports */
22 |
--------------------------------------------------------------------------------
/app/main/components/SmartIcon/getFileIcon/mac.ts:
--------------------------------------------------------------------------------
1 | const remote = require('@electron/remote')
2 |
3 | /**
4 | * Get system icon for file
5 | *
6 | * @param {String} path File path
7 | * @param {Number} options.width
8 | * @param {[type]} options.height
9 | * @return {Promise
67 | {renderPreview()}
68 |
69 | {value}
11 | }
12 |
13 | export default StatusBar
14 |
--------------------------------------------------------------------------------
/app/main/components/StatusBar/styles.module.css:
--------------------------------------------------------------------------------
1 | .statusBar {
2 | position: absolute;
3 | bottom: 0;
4 | right: 0;
5 | padding: 5px;
6 | border-radius: 5px 0 0 0;
7 | border: var(--main-border);
8 | color: var(--secondary-font-color);
9 | background: var(--preview-input-background);
10 | border-width: 1px 0 0 1px;
11 | font-size: .75em;
12 | }
--------------------------------------------------------------------------------
/app/main/constants/actionTypes.ts:
--------------------------------------------------------------------------------
1 | export const UPDATE_TERM = 'UPDATE_TERM'
2 | export const MOVE_CURSOR = 'MOVE_CURSOR'
3 | export const SELECT_ELEMENT = 'SELECT_ELEMENT'
4 | export const SHOW_RESULT = 'SHOW_RESULT'
5 | export const HIDE_RESULT = 'HIDE_RESULT'
6 | export const UPDATE_RESULT = 'UPDATE_RESULT'
7 | export const RESET = 'RESET'
8 | export const CHANGE_VISIBLE_RESULTS = 'CHANGE_VISIBLE_RESULTS'
9 | export const ICON_LOADED = 'ICON_LOADED'
10 | export const SET_STATUS_BAR_TEXT = 'SET_STATUS_BAR_TEXT'
11 |
--------------------------------------------------------------------------------
/app/main/constants/ui.ts:
--------------------------------------------------------------------------------
1 | // Height of main input
2 | export const INPUT_HEIGHT = 45
3 |
4 | // Heigth of default result line
5 | export const RESULT_HEIGHT = 45
6 |
7 | // Width of main window
8 | export const WINDOW_WIDTH = 650
9 |
10 | // Maximum results that would be rendered
11 | export const MAX_RESULTS = 25
12 |
13 | // Results view shows this count of resutls without scrollbar
14 | export const MIN_VISIBLE_RESULTS = 10
15 |
--------------------------------------------------------------------------------
/app/main/createWindow.js:
--------------------------------------------------------------------------------
1 | import {
2 | BrowserWindow, globalShortcut, app, shell
3 | } from 'electron'
4 | import debounce from 'lodash/debounce'
5 | import EventEmitter from 'events'
6 | import config from 'lib/config'
7 |
8 | import {
9 | INPUT_HEIGHT,
10 | WINDOW_WIDTH
11 | } from './constants/ui'
12 |
13 | import buildMenu from './createWindow/buildMenu'
14 | import toggleWindow from './createWindow/toggleWindow'
15 | import handleUrl from './createWindow/handleUrl'
16 |
17 | export default ({ src, isDev }) => {
18 | const [x, y] = config.get('winPosition')
19 |
20 | const browserWindowOptions = {
21 | width: WINDOW_WIDTH,
22 | minWidth: WINDOW_WIDTH,
23 | height: INPUT_HEIGHT,
24 | x,
25 | y,
26 | frame: false,
27 | resizable: false,
28 | transparent: true,
29 | show: config.get('firstStart'),
30 | webPreferences: {
31 | nodeIntegration: true,
32 | nodeIntegrationInSubFrames: false,
33 | enableRemoteModule: true,
34 | contextIsolation: false
35 | },
36 | // Show main window on launch only when application started for the first time
37 | }
38 |
39 | if (process.platform === 'linux') {
40 | browserWindowOptions.type = 'splash'
41 | }
42 |
43 | const mainWindow = new BrowserWindow(browserWindowOptions)
44 |
45 | // Workaround to set the position the first time (centers the window)
46 | config.set('winPosition', mainWindow.getPosition())
47 |
48 | // Float main window above full-screen apps
49 | mainWindow.setAlwaysOnTop(true, 'modal-panel')
50 |
51 | mainWindow.loadURL(src)
52 | mainWindow.settingsChanges = new EventEmitter()
53 |
54 | // Get global shortcut from app settings
55 | let shortcut = config.get('hotkey')
56 |
57 | // Function to toggle main window
58 | const toggleMainWindow = () => toggleWindow(mainWindow)
59 | // Function to show main window
60 | const showMainWindow = () => {
61 | mainWindow.show()
62 | mainWindow.focus()
63 | }
64 |
65 | // Setup event listeners for main window
66 | globalShortcut.register(shortcut, toggleMainWindow)
67 |
68 | mainWindow.on('blur', () => {
69 | if (!isDev() && config.get('hideOnBlur')) {
70 | // Hide window on blur in production
71 | // In development we usually use developer tools that can blur a window
72 | mainWindow.hide()
73 | }
74 | })
75 |
76 | // Save window position when it is being moved
77 | mainWindow.on('move', debounce(() => {
78 | if (!mainWindow.isVisible()) {
79 | return
80 | }
81 |
82 | config.set('winPosition', mainWindow.getPosition())
83 | }, 100))
84 |
85 | mainWindow.on('close', app.quit)
86 |
87 | mainWindow.webContents.on('new-window', (event, url) => {
88 | shell.openExternal(url)
89 | event.preventDefault()
90 | })
91 |
92 | mainWindow.webContents.on('will-navigate', (event, url) => {
93 | if (url !== mainWindow.webContents.getURL()) {
94 | shell.openExternal(url)
95 | event.preventDefault()
96 | }
97 | })
98 |
99 | // Change global hotkey if it is changed in app settings
100 | mainWindow.settingsChanges.on('hotkey', (value) => {
101 | globalShortcut.unregister(shortcut)
102 | shortcut = value
103 | globalShortcut.register(shortcut, toggleMainWindow)
104 | })
105 |
106 | // Change theme css file
107 | mainWindow.settingsChanges.on('theme', (value) => {
108 | mainWindow.webContents.send('message', {
109 | message: 'updateTheme',
110 | payload: value
111 | })
112 | })
113 |
114 | mainWindow.settingsChanges.on('proxy', (value) => {
115 | mainWindow.webContents.session.setProxy({
116 | proxyRules: value
117 | })
118 | })
119 |
120 | // Handle window.hide: if cleanOnHide value in preferences is true
121 | // we clear all results and show empty window every time
122 | const resetResults = () => {
123 | mainWindow.webContents.send('message', {
124 | message: 'showTerm',
125 | payload: ''
126 | })
127 | }
128 |
129 | // Handle change of cleanOnHide value in settins
130 | const handleCleanOnHideChange = (value) => {
131 | if (value) {
132 | mainWindow.on('hide', resetResults)
133 | } else {
134 | mainWindow.removeListener('hide', resetResults)
135 | }
136 | }
137 |
138 | // Set or remove handler when settings changed
139 | mainWindow.settingsChanges.on('cleanOnHide', handleCleanOnHideChange)
140 |
141 | // Set initial handler if it is needed
142 | handleCleanOnHideChange(config.get('cleanOnHide'))
143 |
144 | // Restore focus in previous application
145 | // MacOS only: https://github.com/electron/electron/blob/master/docs/api/app.md#apphide-macos
146 | if (process.platform === 'darwin') {
147 | mainWindow.on('hide', () => {
148 | app.hide()
149 | })
150 | }
151 |
152 | // Show main window when user opens application, but it is already opened
153 | app.on('open-file', (event, path) => handleUrl(mainWindow, path))
154 | app.on('open-url', (event, path) => handleUrl(mainWindow, path))
155 | app.on('activate', showMainWindow)
156 |
157 | // Someone tried to run a second instance, we should focus our window.
158 | const shouldQuit = app.requestSingleInstanceLock()
159 |
160 | if (!shouldQuit) {
161 | app.quit()
162 | } else {
163 | app.on('second-instance', () => {
164 | if (mainWindow) {
165 | if (mainWindow.isMinimized()) mainWindow.restore()
166 | mainWindow.focus()
167 | }
168 | })
169 | }
170 |
171 | // Save in config information, that application has been started
172 | config.set('firstStart', false)
173 |
174 | buildMenu(mainWindow)
175 | return mainWindow
176 | }
177 |
--------------------------------------------------------------------------------
/app/main/createWindow/AppTray.js:
--------------------------------------------------------------------------------
1 | import { Menu, Tray, app } from 'electron'
2 | import showWindowWithTerm from './showWindowWithTerm'
3 | import toggleWindow from './toggleWindow'
4 | import checkForUpdates from './checkForUpdates'
5 |
6 | /**
7 | * Class that controls state of icon in menu bar
8 | */
9 | export default class AppTray {
10 | /**
11 | * @param {String} options.src Absolute path for tray icon
12 | * @param {Function} options.isDev Development mode or not
13 | * @param {BrowserWindow} options.mainWindow
14 | * @param {BrowserWindow} options.backgroundWindow
15 | * @return {AppTray}
16 | */
17 | constructor(options) {
18 | this.tray = null
19 | this.options = options
20 | }
21 |
22 | /**
23 | * Show application icon in menu bar
24 | */
25 | show() {
26 | const tray = new Tray(this.options.src)
27 | tray.setToolTip('Cerebro')
28 | tray.setContextMenu(this.buildMenu())
29 | this.tray = tray
30 | }
31 |
32 | setIsDev(isDev) {
33 | this.options.isDev = isDev
34 | if (this.tray) {
35 | this.tray.setContextMenu(this.buildMenu())
36 | }
37 | }
38 |
39 | buildMenu() {
40 | const { mainWindow, backgroundWindow, isDev } = this.options
41 | const separator = { type: 'separator' }
42 |
43 | const template = [
44 | {
45 | label: 'Toggle Cerebro',
46 | click: () => toggleWindow(mainWindow)
47 | },
48 | separator,
49 | {
50 | label: 'Plugins',
51 | click: () => showWindowWithTerm(mainWindow, 'plugins'),
52 | },
53 | {
54 | label: 'Preferences...',
55 | click: () => showWindowWithTerm(mainWindow, 'Cerebro Settings'),
56 | },
57 | separator,
58 | {
59 | label: 'Check for updates',
60 | click: checkForUpdates,
61 | },
62 | separator,
63 | ]
64 |
65 | if (isDev) {
66 | template.push(separator)
67 | template.push({
68 | label: 'Development',
69 | submenu: [
70 | {
71 | label: 'DevTools (main)',
72 | accelerator: 'CmdOrCtrl+Shift+I',
73 | click: () => mainWindow.webContents.openDevTools({ mode: 'detach' })
74 | },
75 | {
76 | label: 'DevTools (background)',
77 | accelerator: 'CmdOrCtrl+Shift+B',
78 | click: () => backgroundWindow.webContents.openDevTools({ mode: 'detach' })
79 | },
80 | {
81 | label: 'Reload',
82 | click: () => {
83 | app.relaunch()
84 | app.exit()
85 | }
86 | }]
87 | })
88 | }
89 |
90 | template.push(separator)
91 | template.push({
92 | label: 'Quit Cerebro',
93 | click: () => app.quit()
94 | })
95 |
96 | const menu = Menu.buildFromTemplate(template)
97 | Menu.setApplicationMenu(menu)
98 |
99 | return menu
100 | }
101 |
102 | /**
103 | * Hide icon in menu bar
104 | */
105 | hide() {
106 | if (this.tray) {
107 | this.tray.destroy()
108 | this.tray = null
109 | }
110 | }
111 | }
112 |
--------------------------------------------------------------------------------
/app/main/createWindow/autoStart.js:
--------------------------------------------------------------------------------
1 | import { app } from 'electron'
2 | import AutoLaunch from 'auto-launch'
3 |
4 | const isLinux = !['win32', 'darwin'].includes(process.platform)
5 | const isDevelopment = process.env.NODE_ENV === 'development'
6 |
7 | const appLauncher = isLinux
8 | ? new AutoLaunch({ name: 'Cerebro' })
9 | : null
10 |
11 | const isEnabled = async () => (
12 | isLinux
13 | ? appLauncher.isEnabled()
14 | : app.getLoginItemSettings().openAtLogin
15 | )
16 |
17 | const set = async (openAtLogin) => {
18 | const openAtStartUp = openAtLogin && !isDevelopment
19 | if (isLinux) {
20 | return openAtStartUp
21 | ? appLauncher.enable()
22 | : appLauncher.disable()
23 | }
24 |
25 | return app.setLoginItemSettings({ openAtLogin: openAtStartUp })
26 | }
27 |
28 | export default { isEnabled, set }
29 |
--------------------------------------------------------------------------------
/app/main/createWindow/buildMenu.js:
--------------------------------------------------------------------------------
1 | import { Menu, shell, app } from 'electron'
2 |
3 | export default (mainWindow) => {
4 | const template = [{
5 | label: 'Electron',
6 | submenu: [{
7 | label: 'About ElectronReact',
8 | selector: 'orderFrontStandardAboutPanel:'
9 | },
10 | { type: 'separator' },
11 | {
12 | label: 'Services',
13 | submenu: []
14 | },
15 | { type: 'separator' },
16 | {
17 | label: 'Hide ElectronReact',
18 | accelerator: 'Command+H',
19 | selector: 'hide:'
20 | },
21 | {
22 | label: 'Hide Others',
23 | accelerator: 'Command+Shift+H',
24 | selector: 'hideOtherApplications:'
25 | },
26 | {
27 | label: 'Show All',
28 | selector: 'unhideAllApplications:'
29 | },
30 | { type: 'separator' },
31 | {
32 | label: 'Quit',
33 | accelerator: 'Command+Q',
34 | click() { app.quit() }
35 | }]
36 | },
37 | {
38 | label: 'Edit',
39 | submenu: [{
40 | label: 'Undo',
41 | accelerator: 'Command+Z',
42 | selector: 'undo:'
43 | },
44 | {
45 | label: 'Redo',
46 | accelerator: 'Shift+Command+Z',
47 | selector: 'redo:'
48 | },
49 | { type: 'separator' },
50 | {
51 | label: 'Cut',
52 | accelerator: 'Command+X',
53 | selector: 'cut:'
54 | },
55 | {
56 | label: 'Copy',
57 | accelerator: 'Command+C',
58 | selector: 'copy:'
59 | },
60 | {
61 | label: 'Paste',
62 | accelerator: 'Command+V',
63 | selector: 'paste:'
64 | },
65 | {
66 | label: 'Select All',
67 | accelerator: 'Command+A',
68 | selector: 'selectAll:'
69 | }]
70 | },
71 | {
72 | label: 'View',
73 | submenu: [{
74 | label: 'Toggle Full Screen',
75 | accelerator: 'Ctrl+Command+F',
76 | click() {
77 | mainWindow.setFullScreen(!mainWindow.isFullScreen())
78 | }
79 | }]
80 | },
81 | {
82 | label: 'Window',
83 | submenu: [{
84 | label: 'Minimize',
85 | accelerator: 'Command+M',
86 | selector: 'performMiniaturize:'
87 | },
88 | {
89 | label: 'Close',
90 | accelerator: 'Command+W',
91 | selector: 'performClose:'
92 | },
93 | { type: 'separator' },
94 | {
95 | label: 'Bring All to Front',
96 | selector: 'arrangeInFront:'
97 | }]
98 | },
99 |
100 | {
101 | label: 'Help',
102 | submenu: [{
103 | label: 'Learn More',
104 | click() { shell.openExternal('http://electron.atom.io') }
105 | },
106 | {
107 | label: 'Documentation',
108 | click() { shell.openExternal('https://github.com/atom/electron/tree/master/docs#readme') }
109 | },
110 | {
111 | label: 'Community Discussions',
112 | click() { shell.openExternal('https://discuss.atom.io/c/electron') }
113 | },
114 | {
115 | label: 'Search Issues',
116 | click() { shell.openExternal('https://github.com/atom/electron/issues') }
117 | }]
118 | }]
119 |
120 | const menu = Menu.buildFromTemplate(template)
121 | Menu.setApplicationMenu(menu)
122 | }
123 |
--------------------------------------------------------------------------------
/app/main/createWindow/checkForUpdates.js:
--------------------------------------------------------------------------------
1 | import { dialog, app, shell } from 'electron'
2 | import { autoUpdater } from 'electron-updater'
3 |
4 | const currentVersion = app.getVersion()
5 | const DEFAULT_DOWNLOAD_URL = 'https://github.com/cerebroapp/cerebro/releases'
6 |
7 | const TITLE = 'Cerebro Updates'
8 |
9 | const PLATFORM_EXTENSIONS = {
10 | darwin: 'dmg',
11 | linux: 'AppImage',
12 | win32: 'exe'
13 | }
14 |
15 | const { platform } = process
16 | const installerExtension = PLATFORM_EXTENSIONS[platform]
17 |
18 | const findInstaller = (assets) => {
19 | if (!installerExtension) return DEFAULT_DOWNLOAD_URL
20 |
21 | const regexp = new RegExp(`\.${installerExtension}$`)
22 | const downloadUrl = assets
23 | .find(({ url }) => url.match(regexp))
24 |
25 | return downloadUrl || DEFAULT_DOWNLOAD_URL
26 | }
27 |
28 | export default async () => {
29 | try {
30 | const release = await autoUpdater.checkForUpdates()
31 | if (release) {
32 | const { updateInfo: { version, files } } = release
33 | dialog.showMessageBox({
34 | buttons: ['Skip', 'Download'],
35 | defaultId: 1,
36 | cancelId: 0,
37 | title: TITLE,
38 | message: `New version available: ${version}`,
39 | detail: 'Click download to get it now',
40 | }, (response) => {
41 | if (response === 1) {
42 | const url = findInstaller(files)
43 | shell.openExternal(url)
44 | }
45 | })
46 | } else {
47 | dialog.showMessageBox({
48 | title: TITLE,
49 | message: `You are using latest version of Cerebro (${currentVersion})`,
50 | buttons: []
51 | })
52 | }
53 | } catch (err) {
54 | console.log('Catch error!', err)
55 | dialog.showErrorBox(TITLE, 'Error fetching latest version')
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/app/main/createWindow/handleUrl.js:
--------------------------------------------------------------------------------
1 | import { parse } from 'url'
2 |
3 | import showWindowWithTerm from './showWindowWithTerm'
4 |
5 | export default (mainWindow, url) => {
6 | const { host: action, query } = parse(url, { parseQueryString: true })
7 | // Currently only search action supported.
8 | // We can extend this handler to support more
9 | // like `plugins/install` or do something plugin-related
10 | if (action === 'search') {
11 | showWindowWithTerm(mainWindow, query.term)
12 | } else {
13 | showWindowWithTerm(mainWindow, url)
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/app/main/createWindow/showWindowWithTerm.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Show main window with updated search term
3 | *
4 | * @return {BrowserWindow} appWindow
5 | */
6 | export default (appWindow: any, term: string) => {
7 | appWindow.show()
8 | appWindow.focus()
9 | appWindow.webContents.send('message', {
10 | message: 'showTerm',
11 | payload: term
12 | })
13 | }
14 |
--------------------------------------------------------------------------------
/app/main/createWindow/toggleWindow.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Show or hide main window
3 | * @return {BrowserWindow} appWindow
4 | */
5 | export default (appWindow: any) => {
6 | if (appWindow.isVisible()) {
7 | appWindow.blur() // once for blurring the content of the window(?)
8 | appWindow.blur() // twice somehow restores focus to prev foreground window
9 | appWindow.hide()
10 | } else {
11 | appWindow.show()
12 | appWindow.focus()
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/app/main/css/global.css:
--------------------------------------------------------------------------------
1 | @import "system-font.css";
2 | @import url("~normalize.css/normalize.css");
3 | @import url("~react-virtualized/styles.css");
4 |
5 | html,
6 | body {
7 | margin: 0;
8 | padding: 0;
9 | background-color: var(--main-background-color);
10 | color: var(--main-font-color);
11 | }
12 |
13 | body {
14 | position: relative;
15 | height: 100vh;
16 | font-family: var(--main-font);
17 | overflow-y: hidden;
18 | }
19 |
20 | #root {
21 | height: 100%;
22 | }
23 |
--------------------------------------------------------------------------------
/app/main/css/system-font.css:
--------------------------------------------------------------------------------
1 | /*! system-font.css v1.1.0 | CC0-1.0 License | github.com/jonathantneal/system-font-face */
2 |
3 | @font-face {
4 | font-family: system;
5 | font-style: normal;
6 | font-weight: 300;
7 | src: local(".SFNSText-Light"), local(".HelveticaNeueDeskInterface-Light"), local(".LucidaGrandeUI"), local("Ubuntu Light"), local("Segoe UI Light"), local("Roboto-Light"), local("DroidSans"), local("Tahoma");
8 | }
9 |
10 | @font-face {
11 | font-family: system;
12 | font-style: italic;
13 | font-weight: 300;
14 | src: local(".SFNSText-LightItalic"), local(".HelveticaNeueDeskInterface-Italic"), local(".LucidaGrandeUI"), local("Ubuntu Light Italic"), local("Segoe UI Light Italic"), local("Roboto-LightItalic"), local("DroidSans"), local("Tahoma");
15 | }
16 |
17 | @font-face {
18 | font-family: system;
19 | font-style: normal;
20 | font-weight: 400;
21 | src: local(".SFNSText-Regular"), local(".HelveticaNeueDeskInterface-Regular"), local(".LucidaGrandeUI"), local("Ubuntu"), local("Segoe UI"), local("Roboto-Regular"), local("DroidSans"), local("Tahoma");
22 | }
23 |
24 | @font-face {
25 | font-family: system;
26 | font-style: italic;
27 | font-weight: 400;
28 | src: local(".SFNSText-Italic"), local(".HelveticaNeueDeskInterface-Italic"), local(".LucidaGrandeUI"), local("Ubuntu Italic"), local("Segoe UI Italic"), local("Roboto-Italic"), local("DroidSans"), local("Tahoma");
29 | }
30 |
31 | @font-face {
32 | font-family: system;
33 | font-style: normal;
34 | font-weight: 500;
35 | src: local(".SFNSText-Medium"), local(".HelveticaNeueDeskInterface-MediumP4"), local(".LucidaGrandeUI"), local("Ubuntu Medium"), local("Segoe UI Semibold"), local("Roboto-Medium"), local("DroidSans-Bold"), local("Tahoma Bold");
36 | }
37 |
38 | @font-face {
39 | font-family: system;
40 | font-style: italic;
41 | font-weight: 500;
42 | src: local(".SFNSText-MediumItalic"), local(".HelveticaNeueDeskInterface-MediumItalicP4"), local(".LucidaGrandeUI"), local("Ubuntu Medium Italic"), local("Segoe UI Semibold Italic"), local("Roboto-MediumItalic"), local("DroidSans-Bold"), local("Tahoma Bold");
43 | }
44 |
45 | @font-face {
46 | font-family: system;
47 | font-style: normal;
48 | font-weight: 700;
49 | src: local(".SFNSText-Bold"), local(".HelveticaNeueDeskInterface-Bold"), local(".LucidaGrandeUI"), local("Ubuntu Bold"), local("Roboto-Bold"), local("DroidSans-Bold"), local("Segoe UI Bold"), local("Tahoma Bold");
50 | }
51 |
52 | @font-face {
53 | font-family: system;
54 | font-style: italic;
55 | font-weight: 700;
56 | src: local(".SFNSText-BoldItalic"), local(".HelveticaNeueDeskInterface-BoldItalic"), local(".LucidaGrandeUI"), local("Ubuntu Bold Italic"), local("Roboto-BoldItalic"), local("DroidSans-Bold"), local("Segoe UI Bold Italic"), local("Tahoma Bold");
57 | }
58 |
--------------------------------------------------------------------------------
/app/main/css/themes/dark.css:
--------------------------------------------------------------------------------
1 | :root {
2 | /* Main fonts and colors */
3 | --main-background-color: rgba(62, 65, 67, 1);
4 | --main-font: system, sans-serif;
5 | --main-font-color: white;
6 |
7 | /* border styles */
8 | --main-border: 1px solid #686869;
9 |
10 | /* Secondary fonts and colors */
11 | --secondary-font-color: #9B9D9F;
12 |
13 | /* results list */
14 | --result-background: transparent;
15 | --result-title-color: var(--main-font-color);
16 | --result-subtitle-color: #cccccc;
17 |
18 | /* selected result */
19 | --selected-result-title-color: white;
20 | --selected-result-subtitle-color: var(--result-subtitle-color);
21 | --selected-result-background: #1972D6;
22 |
23 | /* scrollbar */
24 | --scroll-background: var(--main-background-color);
25 | --scroll-track: #2E2E2C;
26 | --scroll-track-active: var(--scroll-track);
27 | --scroll-track-hover: var(--scroll-track);
28 | --scroll-thumb: var(--secondary-font-color);
29 | --scroll-thumb-hover: var(--scroll-thumb);
30 | --scroll-thumb-active: var(--main-font-color);
31 | --scroll-width: 5px;
32 | --scroll-height: 5px;
33 |
34 | /* inputs */
35 | --preview-input-background: #2E2E2C;
36 | --preview-input-color: var(--main-font-color);
37 | --preview-input-border: 0;
38 |
39 | /* filter for previews */
40 | --preview-filter: invert(100%) hue-rotate(180deg) contrast(80%);
41 | }
42 |
--------------------------------------------------------------------------------
/app/main/css/themes/light.css:
--------------------------------------------------------------------------------
1 | :root {
2 | /* Main fonts and colors */
3 | --main-background-color: rgba(255, 255, 255, 1);
4 | --main-font: system, sans-serif;
5 | --main-font-color: #000000;
6 |
7 | /* border styles */
8 | --main-border: 1px solid #eee;
9 |
10 | /* Secondary fonts and colors */
11 | --secondary-font-color: #999;
12 |
13 | /* results list */
14 | --result-background: transparent;
15 | --result-title-color: var(--main-font-color);
16 | --result-subtitle-color: #cccccc;
17 |
18 | /* selected result */
19 | --selected-result-title-color: white;
20 | --selected-result-subtitle-color: var(--result-subtitle-color);
21 | --selected-result-background: rgba(18, 110, 219, 1);
22 |
23 | /* scrollbar */
24 | --scroll-background: var(--main-background-color);
25 | --scroll-track: #e0e0e0;
26 | --scroll-track-active: var(--scroll-track);
27 | --scroll-track-hover: var(--scroll-track);
28 | --scroll-thumb: var(--secondary-font-color);
29 | --scroll-thumb-hover: var(--scroll-thumb);
30 | --scroll-thumb-active: var(--main-font-color);
31 | --scroll-width: 5px;
32 | --scroll-height: 5px;
33 |
34 | /* inputs */
35 | --preview-input-background: white;
36 | --preview-input-color: var(--main-font-color);
37 | --preview-input-border: 1px solid #ccc;
38 |
39 | /* filter for previews */
40 | --preview-filter: none;
41 | }
42 |
--------------------------------------------------------------------------------
/app/main/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
22 |
23 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/app/main/main.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import ReactDOM from 'react-dom'
3 | import { Provider } from 'react-redux'
4 |
5 | import initializePlugins from 'lib/initializePlugins'
6 | import { on } from 'lib/rpc'
7 | import config from 'lib/config'
8 | import { updateTerm } from './actions/search'
9 | import store from './store'
10 | import Cerebro from './components/Cerebro'
11 | import './css/global.css'
12 |
13 | global.React = React
14 | global.ReactDOM = ReactDOM
15 | global.isBackground = false
16 |
17 | /**
18 | * Change current theme
19 | *
20 | * @param {String} src Absolute path to new theme css file
21 | */
22 | const changeTheme = (src) => {
23 | document.getElementById('cerebro-theme').href = src
24 | }
25 |
26 | // Set theme from config
27 | changeTheme(config.get('theme'))
28 |
29 | // Render main container
30 | ReactDOM.render(
31 |
43 | { Object.keys(settings).map(renderSetting) }
44 |
45 | )
46 | }
47 |
48 | export default Settings
49 |
50 | Settings.propTypes = {
51 | name: PropTypes.string.isRequired,
52 | settings: PropTypes.object.isRequired,
53 | }
54 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/Preview/index.js:
--------------------------------------------------------------------------------
1 | import React, { useState, useEffect } from 'react'
2 | import PropTypes from 'prop-types'
3 | import { KeyboardNav, KeyboardNavItem } from '@cerebroapp/cerebro-ui'
4 | import { client } from 'lib/plugins'
5 | import ReactMarkdown from 'react-markdown'
6 |
7 | import ActionButton from './ActionButton.js'
8 | import Settings from './Settings'
9 | import getReadme from '../getReadme'
10 | import styles from './styles.module.css'
11 | import * as format from '../format'
12 |
13 | function Description({ repoName }) {
14 | const isRelative = (src) => !src.match(/^(https?:|data:)/)
15 |
16 | const urlTransform = (src) => {
17 | if (isRelative(src)) return `http://raw.githubusercontent.com/${repoName}/master/${src}`
18 | return src
19 | }
20 |
21 | const [readme, setReadme] = useState(null)
22 |
23 | useEffect(() => { getReadme(repoName).then(setReadme) }, [])
24 |
25 | if (!readme) return null
26 |
27 | return (
28 |
65 |
69 |
111 | {showDescription &&
113 | )
114 | }
115 |
116 | Preview.propTypes = {
117 | plugin: PropTypes.object.isRequired,
118 | onComplete: PropTypes.func.isRequired,
119 | }
120 |
121 | export default Preview
122 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/Preview/styles.module.css:
--------------------------------------------------------------------------------
1 | .preview {
2 | align-self: flex-start;
3 | width: 100%;
4 | }
5 |
6 | .header {
7 | border-bottom: var(--main-border);
8 | margin-bottom: 15px;
9 | }
10 |
11 | .markdown {
12 | font-size: .8em;
13 | align-self: flex-start;
14 | font-size: 16px;
15 | padding: 0 10px;
16 | p {
17 | font-size: 1em;
18 | margin: 0 0 10px;
19 | }
20 | h1, h2, h3, h4 {
21 | color: var(--main-font-color);
22 | margin-top: 24px;
23 | margin-bottom: 16px;
24 | font-weight: 500;
25 | line-height: 1.25;
26 | }
27 | h1 {
28 | padding-bottom: 0.3em;
29 | font-size: 2em;
30 | border-bottom: var(--main-border);
31 | }
32 | h2 {
33 | padding-bottom: 0.3em;
34 | font-size: 1.5em;
35 | border-bottom: var(--main-border);
36 | }
37 | pre {
38 | padding: 16px;
39 | overflow: auto;
40 | font-size: 85%;
41 | line-height: 1.45;
42 | filter: invert(10%);
43 | background: var(--main-background-color);
44 | border-radius: 3px;
45 | code {
46 | padding: 0;
47 | background: transparent;
48 | &:before, &:after {
49 | content: none;
50 | }
51 | }
52 | }
53 | blockquote {
54 | border-left: 3px solid #999;
55 | margin: 15px 0;
56 | padding: 5px 15px;
57 | p:last-child {
58 | margin-bottom: 0;
59 | }
60 | }
61 | code {
62 | padding: 0;
63 | padding-top: 0.2em;
64 | padding-bottom: 0.2em;
65 | margin: 0;
66 | font-size: 85%;
67 | background-color: rgba(0,0,0,0.04);
68 | border-radius: 3px;
69 | &:after {
70 | letter-spacing: -0.2em;
71 | content: "\00a0";
72 | }
73 | &:before {
74 | letter-spacing: -0.2em;
75 | content: "\00a0";
76 | }
77 | }
78 | img {
79 | max-width: 100%;
80 | }
81 | a {
82 | color: #4078c0;
83 | text-decoration: none;
84 | }
85 | ul {
86 | padding-left: 2em;
87 | list-style-type: disc;
88 | }
89 | li {
90 | list-style-type: disc;
91 | }
92 | li + li {
93 | margin-top: 0.25em;
94 | }
95 | }
96 |
97 | .settingsWrapper {
98 | margin: 15px 0;
99 | }
100 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/StatusBar/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import PropTypes from 'prop-types'
3 | import styles from './styles.module.css'
4 |
5 | function StatusBar({ value }) {
6 | return {`${format.name(name)} (${version})`}
66 | 67 |{format.description(description)}
68 |
70 |
71 | {settings && (
72 | setShowSettings((prev) => !prev)}>
73 | Settings
74 |
75 | )}
76 |
77 | {showSettings && setShowDescription((prev) => !prev)}>
105 | Details
106 |
107 | )}
108 |
109 |
110 | {value}
7 | }
8 |
9 | StatusBar.propTypes = {
10 | value: PropTypes.string.isRequired
11 | }
12 |
13 | export default StatusBar
14 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/StatusBar/styles.module.css:
--------------------------------------------------------------------------------
1 | .statusBar {
2 | position: absolute;
3 | right: 0;
4 | bottom: 0;
5 | z-index: 11;
6 | font-size: 11px;
7 | color: var(--secondary-font-color);
8 | background: var(--preview-input-background);
9 | padding: 5px;
10 | border-radius: 5px 0 0 0;
11 | border-top: var(--main-border);
12 | border-left: var(--main-border);
13 | max-width: 250px;
14 | overflow: hidden;
15 | text-overflow: ellipsis;
16 | }
--------------------------------------------------------------------------------
/app/plugins/core/plugins/blacklist.js:
--------------------------------------------------------------------------------
1 | /**
2 | * This file contains plugins that have been blacklisted.
3 | * The main purpose of this is to hide plugins that have been republished under our scope.
4 | * The name must match (case sensitive) the name in the `package.json`.
5 | */
6 | export default [
7 | 'cerebro-basic-apps', // @cerebroapp/cerebro-basic-apps
8 | 'cerebro-mac-apps', // @cerebroapp/cerebro-mac-apps
9 | 'cerebro-brew', // @cerebroapp/cerebro-brew
10 | ]
11 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/format.js:
--------------------------------------------------------------------------------
1 | import {
2 | flow, words, capitalize, trim, map, join
3 | } from 'lodash/fp'
4 |
5 | /**
6 | * Remove unnecessary information from plugin description
7 | * like `Cerebro plugin for`
8 | * @param {String} str
9 | * @return {String}
10 | */
11 | const removeDescriptionNoise = (str) => (
12 | (str || '').replace(/^cerebro\s?(plugin)?\s?(to|for)?/i, '')
13 | )
14 |
15 | /**
16 | * Remove unnecessary information from plugin name
17 | * like `cerebro-plugin-` or `cerebro-`
18 | * @param {String} str
19 | * @return {String}
20 | */
21 | const removeNameNoise = (str) => (
22 | (str || '').replace(/^cerebro-(plugin)?-?/i, '')
23 | )
24 |
25 | export const name = (text = '') => flow(
26 | trim,
27 | words,
28 | map(capitalize),
29 | join(' ')
30 | )(removeNameNoise(text.toLowerCase()))
31 |
32 | export const description = flow(
33 | removeDescriptionNoise,
34 | trim,
35 | capitalize,
36 | )
37 |
38 | export const version = (plugin) => (
39 | plugin.isUpdateAvailable
40 | ? `${plugin.installedVersion} → ${plugin.version}`
41 | : plugin.version
42 | )
43 |
--------------------------------------------------------------------------------
/app/plugins/core/plugins/getAvailablePlugins.js:
--------------------------------------------------------------------------------
1 | /**
2 | * API endpoint to search all cerebro plugins
3 | * @type {String}
4 | */
5 | const URL = 'https://registry.npmjs.com/-/v1/search?from=0&size=500&text=keywords:cerebro-plugin,cerebro-extracted-plugin'
6 |
7 | const sortByPopularity = (a, b) => a.score.detail.popularity > b.score.detail.popularity ? -1 : 1
8 |
9 | /**
10 | * Get all available plugins for Cerebro
11 | * @return {Promise
129 |
136 |
137 | )
138 | }
139 |
140 | Hotkey.propTypes = {
141 | hotkey: PropTypes.string.isRequired,
142 | onChange: PropTypes.func.isRequired,
143 | }
144 |
145 | export default Hotkey
146 |
--------------------------------------------------------------------------------
/app/plugins/core/settings/Settings/countries.js:
--------------------------------------------------------------------------------
1 | export default [
2 | { value: 'AF', label: 'Afghanistan' },
3 | { value: 'AX', label: 'Åland Islands' },
4 | { value: 'AL', label: 'Albania' },
5 | { value: 'DZ', label: 'Algeria' },
6 | { value: 'AS', label: 'American Samoa' },
7 | { value: 'AD', label: 'Andorra' },
8 | { value: 'AO', label: 'Angola' },
9 | { value: 'AI', label: 'Anguilla' },
10 | { value: 'AQ', label: 'Antarctica' },
11 | { value: 'AG', label: 'Antigua and Barbuda' },
12 | { value: 'AR', label: 'Argentina' },
13 | { value: 'AM', label: 'Armenia' },
14 | { value: 'AW', label: 'Aruba' },
15 | { value: 'AU', label: 'Australia' },
16 | { value: 'AT', label: 'Austria' },
17 | { value: 'AZ', label: 'Azerbaijan' },
18 | { value: 'BS', label: 'The Bahamas' },
19 | { value: 'BH', label: 'Bahrain' },
20 | { value: 'BD', label: 'Bangladesh' },
21 | { value: 'BB', label: 'Barbados' },
22 | { value: 'BY', label: 'Belarus' },
23 | { value: 'BE', label: 'Belgium' },
24 | { value: 'BZ', label: 'Belize' },
25 | { value: 'BJ', label: 'Benin' },
26 | { value: 'BM', label: 'Bermuda' },
27 | { value: 'BT', label: 'Bhutan' },
28 | { value: 'BO', label: 'Bolivia' },
29 | { value: 'BQ', label: 'Bonaire' },
30 | { value: 'BA', label: 'Bosnia and Herzegovina' },
31 | { value: 'BW', label: 'Botswana' },
32 | { value: 'BV', label: 'Bouvet Island' },
33 | { value: 'BR', label: 'Brazil' },
34 | { value: 'IO', label: 'British Indian Ocean Territory' },
35 | { value: 'UM', label: 'United States Minor Outlying Islands' },
36 | { value: 'VG', label: 'Virgin Islands (British)' },
37 | { value: 'VI', label: 'Virgin Islands (U.S.)' },
38 | { value: 'BN', label: 'Brunei' },
39 | { value: 'BG', label: 'Bulgaria' },
40 | { value: 'BF', label: 'Burkina Faso' },
41 | { value: 'BI', label: 'Burundi' },
42 | { value: 'KH', label: 'Cambodia' },
43 | { value: 'CM', label: 'Cameroon' },
44 | { value: 'CA', label: 'Canada' },
45 | { value: 'CV', label: 'Cape Verde' },
46 | { value: 'KY', label: 'Cayman Islands' },
47 | { value: 'CF', label: 'Central African Republic' },
48 | { value: 'TD', label: 'Chad' },
49 | { value: 'CL', label: 'Chile' },
50 | { value: 'CN', label: 'China' },
51 | { value: 'CX', label: 'Christmas Island' },
52 | { value: 'CC', label: 'Cocos (Keeling) Islands' },
53 | { value: 'CO', label: 'Colombia' },
54 | { value: 'KM', label: 'Comoros' },
55 | { value: 'CG', label: 'Republic of the Congo' },
56 | { value: 'CD', label: 'Democratic Republic of the Congo' },
57 | { value: 'CK', label: 'Cook Islands' },
58 | { value: 'CR', label: 'Costa Rica' },
59 | { value: 'HR', label: 'Croatia' },
60 | { value: 'CU', label: 'Cuba' },
61 | { value: 'CW', label: 'Curaçao' },
62 | { value: 'CY', label: 'Cyprus' },
63 | { value: 'CZ', label: 'Czech Republic' },
64 | { value: 'DK', label: 'Denmark' },
65 | { value: 'DJ', label: 'Djibouti' },
66 | { value: 'DM', label: 'Dominica' },
67 | { value: 'DO', label: 'Dominican Republic' },
68 | { value: 'EC', label: 'Ecuador' },
69 | { value: 'EG', label: 'Egypt' },
70 | { value: 'SV', label: 'El Salvador' },
71 | { value: 'GQ', label: 'Equatorial Guinea' },
72 | { value: 'ER', label: 'Eritrea' },
73 | { value: 'EE', label: 'Estonia' },
74 | { value: 'ET', label: 'Ethiopia' },
75 | { value: 'FK', label: 'Falkland Islands' },
76 | { value: 'FO', label: 'Faroe Islands' },
77 | { value: 'FJ', label: 'Fiji' },
78 | { value: 'FI', label: 'Finland' },
79 | { value: 'FR', label: 'France' },
80 | { value: 'GF', label: 'French Guiana' },
81 | { value: 'PF', label: 'French Polynesia' },
82 | { value: 'TF', label: 'French Southern and Antarctic Lands' },
83 | { value: 'GA', label: 'Gabon' },
84 | { value: 'GM', label: 'The Gambia' },
85 | { value: 'GE', label: 'Georgia' },
86 | { value: 'DE', label: 'Germany' },
87 | { value: 'GH', label: 'Ghana' },
88 | { value: 'GI', label: 'Gibraltar' },
89 | { value: 'GR', label: 'Greece' },
90 | { value: 'GL', label: 'Greenland' },
91 | { value: 'GD', label: 'Grenada' },
92 | { value: 'GP', label: 'Guadeloupe' },
93 | { value: 'GU', label: 'Guam' },
94 | { value: 'GT', label: 'Guatemala' },
95 | { value: 'GG', label: 'Guernsey' },
96 | { value: 'GW', label: 'Guinea-Bissau' },
97 | { value: 'GY', label: 'Guyana' },
98 | { value: 'HT', label: 'Haiti' },
99 | { value: 'HM', label: 'Heard Island and McDonald Islands' },
100 | { value: 'VA', label: 'Holy See' },
101 | { value: 'HN', label: 'Honduras' },
102 | { value: 'HK', label: 'Hong Kong' },
103 | { value: 'HU', label: 'Hungary' },
104 | { value: 'IS', label: 'Iceland' },
105 | { value: 'IN', label: 'India' },
106 | { value: 'ID', label: 'Indonesia' },
107 | { value: 'CI', label: 'Ivory Coast' },
108 | { value: 'IR', label: 'Iran' },
109 | { value: 'IQ', label: 'Iraq' },
110 | { value: 'IE', label: 'Republic of Ireland' },
111 | { value: 'IM', label: 'Isle of Man' },
112 | { value: 'IL', label: 'Israel' },
113 | { value: 'IT', label: 'Italy' },
114 | { value: 'JM', label: 'Jamaica' },
115 | { value: 'JP', label: 'Japan' },
116 | { value: 'JE', label: 'Jersey' },
117 | { value: 'JO', label: 'Jordan' },
118 | { value: 'KZ', label: 'Kazakhstan' },
119 | { value: 'KE', label: 'Kenya' },
120 | { value: 'KI', label: 'Kiribati' },
121 | { value: 'KW', label: 'Kuwait' },
122 | { value: 'KG', label: 'Kyrgyzstan' },
123 | { value: 'LA', label: 'Laos' },
124 | { value: 'LV', label: 'Latvia' },
125 | { value: 'LB', label: 'Lebanon' },
126 | { value: 'LS', label: 'Lesotho' },
127 | { value: 'LR', label: 'Liberia' },
128 | { value: 'LY', label: 'Libya' },
129 | { value: 'LI', label: 'Liechtenstein' },
130 | { value: 'LT', label: 'Lithuania' },
131 | { value: 'LU', label: 'Luxembourg' },
132 | { value: 'MO', label: 'Macau' },
133 | { value: 'MK', label: 'Republic of Macedonia' },
134 | { value: 'MG', label: 'Madagascar' },
135 | { value: 'MW', label: 'Malawi' },
136 | { value: 'MY', label: 'Malaysia' },
137 | { value: 'MV', label: 'Maldives' },
138 | { value: 'ML', label: 'Mali' },
139 | { value: 'MT', label: 'Malta' },
140 | { value: 'MH', label: 'Marshall Islands' },
141 | { value: 'MQ', label: 'Martinique' },
142 | { value: 'MR', label: 'Mauritania' },
143 | { value: 'MU', label: 'Mauritius' },
144 | { value: 'YT', label: 'Mayotte' },
145 | { value: 'MX', label: 'Mexico' },
146 | { value: 'FM', label: 'Federated States of Micronesia' },
147 | { value: 'MD', label: 'Moldova' },
148 | { value: 'MC', label: 'Monaco' },
149 | { value: 'MN', label: 'Mongolia' },
150 | { value: 'ME', label: 'Montenegro' },
151 | { value: 'MS', label: 'Montserrat' },
152 | { value: 'MA', label: 'Morocco' },
153 | { value: 'MZ', label: 'Mozambique' },
154 | { value: 'MM', label: 'Myanmar' },
155 | { value: 'NA', label: 'Namibia' },
156 | { value: 'NR', label: 'Nauru' },
157 | { value: 'NP', label: 'Nepal' },
158 | { value: 'NL', label: 'Netherlands' },
159 | { value: 'NC', label: 'New Caledonia' },
160 | { value: 'NZ', label: 'New Zealand' },
161 | { value: 'NI', label: 'Nicaragua' },
162 | { value: 'NE', label: 'Niger' },
163 | { value: 'NG', label: 'Nigeria' },
164 | { value: 'NU', label: 'Niue' },
165 | { value: 'NF', label: 'Norfolk Island' },
166 | { value: 'KP', label: 'North Korea' },
167 | { value: 'MP', label: 'Northern Mariana Islands' },
168 | { value: 'NO', label: 'Norway' },
169 | { value: 'OM', label: 'Oman' },
170 | { value: 'PK', label: 'Pakistan' },
171 | { value: 'PW', label: 'Palau' },
172 | { value: 'PS', label: 'Palestine' },
173 | { value: 'PA', label: 'Panama' },
174 | { value: 'PG', label: 'Papua New Guinea' },
175 | { value: 'PY', label: 'Paraguay' },
176 | { value: 'PE', label: 'Peru' },
177 | { value: 'PH', label: 'Philippines' },
178 | { value: 'PN', label: 'Pitcairn Islands' },
179 | { value: 'PL', label: 'Poland' },
180 | { value: 'PT', label: 'Portugal' },
181 | { value: 'PR', label: 'Puerto Rico' },
182 | { value: 'QA', label: 'Qatar' },
183 | { value: 'XK', label: 'Republic of Kosovo' },
184 | { value: 'RE', label: 'Réunion' },
185 | { value: 'RO', label: 'Romania' },
186 | { value: 'RU', label: 'Russia' },
187 | { value: 'RW', label: 'Rwanda' },
188 | { value: 'BL', label: 'Saint Barthélemy' },
189 | { value: 'SH', label: 'Saint Helena' },
190 | { value: 'KN', label: 'Saint Kitts and Nevis' },
191 | { value: 'LC', label: 'Saint Lucia' },
192 | { value: 'MF', label: 'Saint Martin' },
193 | { value: 'PM', label: 'Saint Pierre and Miquelon' },
194 | { value: 'VC', label: 'Saint Vincent and the Grenadines' },
195 | { value: 'WS', label: 'Samoa' },
196 | { value: 'SM', label: 'San Marino' },
197 | { value: 'ST', label: 'São Tomé and Príncipe' },
198 | { value: 'SA', label: 'Saudi Arabia' },
199 | { value: 'SN', label: 'Senegal' },
200 | { value: 'RS', label: 'Serbia' },
201 | { value: 'SC', label: 'Seychelles' },
202 | { value: 'SL', label: 'Sierra Leone' },
203 | { value: 'SG', label: 'Singapore' },
204 | { value: 'SX', label: 'Sint Maarten' },
205 | { value: 'SK', label: 'Slovakia' },
206 | { value: 'SI', label: 'Slovenia' },
207 | { value: 'SB', label: 'Solomon Islands' },
208 | { value: 'SO', label: 'Somalia' },
209 | { value: 'ZA', label: 'South Africa' },
210 | { value: 'GS', label: 'South Georgia' },
211 | { value: 'KR', label: 'South Korea' },
212 | { value: 'SS', label: 'South Sudan' },
213 | { value: 'ES', label: 'Spain' },
214 | { value: 'LK', label: 'Sri Lanka' },
215 | { value: 'SD', label: 'Sudan' },
216 | { value: 'SR', label: 'Surinae' },
217 | { value: 'SJ', label: 'Svalbard and Jan Mayen' },
218 | { value: 'SZ', label: 'Swaziland' },
219 | { value: 'SE', label: 'Sweden' },
220 | { value: 'CH', label: 'Switzerland' },
221 | { value: 'SY', label: 'Syria' },
222 | { value: 'TW', label: 'Taiwan' },
223 | { value: 'TJ', label: 'Tajikistan' },
224 | { value: 'TZ', label: 'Tanzania' },
225 | { value: 'TH', label: 'Thailand' },
226 | { value: 'TL', label: 'East Timor' },
227 | { value: 'TG', label: 'Togo' },
228 | { value: 'TK', label: 'Tokelau' },
229 | { value: 'TO', label: 'Tonga' },
230 | { value: 'TT', label: 'Trinidad and Tobago' },
231 | { value: 'TN', label: 'Tunisia' },
232 | { value: 'TR', label: 'Turkey' },
233 | { value: 'TM', label: 'Turkmenistan' },
234 | { value: 'TC', label: 'Turks and Caicos Islands' },
235 | { value: 'TV', label: 'Tuvalu' },
236 | { value: 'UG', label: 'Uganda' },
237 | { value: 'UA', label: 'Ukraine' },
238 | { value: 'AE', label: 'United Arab Emirates' },
239 | { value: 'GB', label: 'United Kingdom' },
240 | { value: 'US', label: 'United States' },
241 | { value: 'UY', label: 'Uruguay' },
242 | { value: 'UZ', label: 'Uzbekistan' },
243 | { value: 'VU', label: 'Vanuatu' },
244 | { value: 'VE', label: 'Venezuela' },
245 | { value: 'VN', label: 'Vietnam' },
246 | { value: 'WF', label: 'Wallis and Futuna' },
247 | { value: 'EH', label: 'Western Sahara' },
248 | { value: 'YE', label: 'Yemen' },
249 | { value: 'ZM', label: 'Zambia' },
250 | { value: 'ZW', label: 'Zimbabwe' }
251 | ]
252 |
--------------------------------------------------------------------------------
/app/plugins/core/settings/Settings/index.js:
--------------------------------------------------------------------------------
1 | import React, { useState } from 'react'
2 | import PropTypes from 'prop-types'
3 | import { FormComponents } from '@cerebroapp/cerebro-ui'
4 | import themes from 'lib/themes'
5 |
6 | import Hotkey from './Hotkey'
7 | import countries from './countries'
8 | import styles from './styles.module.css'
9 |
10 | const {
11 | Select, Checkbox, Wrapper, Text
12 | } = FormComponents
13 |
14 | function Settings({ get, set }) {
15 | const [state, setState] = useState(() => ({
16 | hotkey: get('hotkey'),
17 | showInTray: get('showInTray'),
18 | country: get('country'),
19 | theme: get('theme'),
20 | proxy: get('proxy'),
21 | developerMode: get('developerMode'),
22 | cleanOnHide: get('cleanOnHide'),
23 | selectOnShow: get('selectOnShow'),
24 | pluginsSettings: get('plugins'),
25 | openAtLogin: get('openAtLogin'),
26 | searchBarPlaceholder: get('searchBarPlaceholder')
27 | }))
28 |
29 | const changeConfig = (key, value) => {
30 | set(key, value)
31 | setState((prevState) => ({ ...prevState, [key]: value }))
32 | }
33 |
34 | return (
35 |
36 |
37 | changeConfig('hotkey', key)}
40 | />
41 |
42 |
93 | )
94 | }
95 |
96 | Settings.propTypes = {
97 | get: PropTypes.func.isRequired,
98 | set: PropTypes.func.isRequired
99 | }
100 |
101 | export default Settings
102 |
--------------------------------------------------------------------------------
/app/plugins/core/settings/Settings/styles.module.css:
--------------------------------------------------------------------------------
1 | .settings {
2 | display: flex;
3 | align-self: flex-start;
4 | flex-direction: column;
5 | align-items: center;
6 | }
7 |
8 | .label {
9 | margin-right: 15px;
10 | margin-top: 8px;
11 | min-width: 60px;
12 | max-width: 60px;
13 | }
14 |
15 | .checkbox {
16 | margin-right: 5px;
17 | }
18 |
19 | .settingItem {
20 | padding: 20px;
21 | box-sizing: border-box;
22 | width: 100%;
23 | border-color: #d9d9d9 #ccc #b3b3b3;
24 | border-top: 1px solid #ccc;
25 | margin-top: 16px;
26 | }
27 |
28 | .header {
29 | font-weight: bold;
30 | }
31 |
32 | .input {
33 | font-size: 16px;
34 | line-height: 34px;
35 | padding: 0 10px;
36 | box-sizing: border-box;
37 | width: 100%;
38 | border-color: #d9d9d9 #ccc #b3b3b3;
39 | border-radius: 4px;
40 | border: 1px solid #ccc;
41 | }
42 |
--------------------------------------------------------------------------------
/app/plugins/core/settings/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import { search } from 'cerebro-tools'
3 | import Settings from './Settings'
4 | import icon from '../icon.png'
5 |
6 | // Settings plugin name
7 | const NAME = 'Cerebro Settings'
8 |
9 | // Settings plugins in the end of list
10 | const order = 9
11 |
12 | // Phrases that used to find settings plugins
13 | const KEYWORDS = [
14 | NAME,
15 | 'Cerebro Preferences',
16 | 'cfg',
17 | 'config',
18 | 'params'
19 | ]
20 |
21 | /**
22 | * Plugin to show app settings in results list
23 | *
24 | * @param {String} options.term
25 | * @param {Function} options.display
26 | */
27 | const settingsPlugin = ({
28 | term, display, config, actions
29 | }) => {
30 | const found = search(KEYWORDS, term).length > 0
31 | if (found) {
32 | const results = [{
33 | order,
34 | icon,
35 | title: NAME,
36 | term: NAME,
37 | getPreview: () => (
38 | {CEREBRO_VERSION}
),
36 | onSelect: (event) => {
37 | event.preventDefault()
38 | actions.replaceTerm(NAME)
39 | }
40 | }]
41 | display(results)
42 | }
43 | }
44 |
45 | export default { name: NAME, fn: versionPlugin }
46 |
--------------------------------------------------------------------------------
/app/plugins/externalPlugins.js:
--------------------------------------------------------------------------------
1 | import debounce from 'lodash/debounce'
2 | import chokidar from 'chokidar'
3 | import path from 'path'
4 | import initPlugin from 'lib/initPlugin'
5 | import { modulesDirectory, ensureFiles, settings } from 'lib/plugins'
6 |
7 | const plugins = {}
8 |
9 | const requirePlugin = (pluginPath) => {
10 | try {
11 | let plugin = window.require(pluginPath)
12 | // Fallback for plugins with structure like `{default: {fn: ...}}`
13 | const keys = Object.keys(plugin)
14 | if (keys.length === 1 && keys[0] === 'default') {
15 | plugin = plugin.default
16 | }
17 | return plugin
18 | } catch (error) {
19 | // catch all errors from plugin loading
20 | console.log('Error requiring', pluginPath)
21 | console.log(error)
22 | }
23 | }
24 |
25 | /**
26 | * Validate plugin module signature
27 | *
28 | * @param {Object} plugin
29 | * @return {Boolean}
30 | */
31 | const isPluginValid = (plugin) => (
32 | plugin
33 | // Check existing of main plugin function
34 | && typeof plugin.fn === 'function'
35 | // Check that plugin function accepts 0 or 1 argument
36 | && plugin.fn.length <= 1
37 | )
38 |
39 | ensureFiles()
40 |
41 | /* As we support scoped plugins, using 'base' as plugin name is no longer valid
42 | because it is not unique. '@example/plugin' and '@test/plugin' would both be treated as 'plugin'
43 | So now we must introduce the scope to the plugin name
44 | This function returns the name with the scope if it is present in the path
45 | */
46 | const getPluginName = (pluginPath) => {
47 | const { base, dir } = path.parse(pluginPath)
48 | const scope = dir.match(/@.+$/)
49 | if (!scope) return base
50 | return `${scope[0]}/${base}`
51 | }
52 |
53 | const setupPluginsWatcher = () => {
54 | if (global.isBackground) return
55 |
56 | const pluginsWatcher = chokidar.watch(modulesDirectory, { depth: 1 })
57 | pluginsWatcher.on('unlinkDir', (pluginPath) => {
58 | const { base, dir } = path.parse(pluginPath)
59 | if (base.match(/node_modules/) || base.match(/^@/)) return
60 | if (!dir.match(/node_modules$/) && !dir.match(/@.+$/)) return
61 |
62 | const pluginName = getPluginName(pluginPath)
63 |
64 | const requirePath = window.require.resolve(pluginPath)
65 | delete plugins[pluginName]
66 | delete window.require.cache[requirePath]
67 | console.log(`[${pluginName}] Plugin removed`)
68 | })
69 |
70 | pluginsWatcher.on('addDir', (pluginPath) => {
71 | const { base, dir } = path.parse(pluginPath)
72 |
73 | if (base.match(/node_modules/) || base.match(/^@/)) return
74 | if (!dir.match(/node_modules$/) && !dir.match(/@.+$/)) return
75 |
76 | const pluginName = getPluginName(pluginPath)
77 |
78 | setTimeout(() => {
79 | console.group(`Load plugin: ${pluginName}`)
80 | console.log(`Path: ${pluginPath}...`)
81 | const plugin = requirePlugin(pluginPath)
82 | if (!isPluginValid(plugin)) {
83 | console.log('Plugin is not valid, skipped')
84 | console.groupEnd()
85 | return
86 | }
87 | if (!settings.validate(plugin)) {
88 | console.log('Invalid plugins settings')
89 | console.groupEnd()
90 | return
91 | }
92 |
93 | console.log('Loaded.')
94 | const requirePath = window.require.resolve(pluginPath)
95 | const watcher = chokidar.watch(pluginPath, { depth: 0 })
96 | watcher.on('change', debounce(() => {
97 | console.log(`[${pluginName}] Update plugin`)
98 | delete window.require.cache[requirePath]
99 | plugins[pluginName] = window.require(pluginPath)
100 | console.log(`[${pluginName}] Plugin updated`)
101 | }, 1000))
102 | plugins[pluginName] = plugin
103 | initPlugin(plugin, pluginName)
104 | console.groupEnd()
105 | }, 1000)
106 | })
107 | }
108 |
109 | setupPluginsWatcher()
110 |
111 | export default plugins
112 |
--------------------------------------------------------------------------------
/app/plugins/index.ts:
--------------------------------------------------------------------------------
1 | import core from './core'
2 | import externalPlugins from './externalPlugins'
3 |
4 | const pluginsService = {
5 | corePlugins: core,
6 | allPlugins: Object.assign(externalPlugins, core),
7 | externalPlugins,
8 | }
9 |
10 | export default pluginsService
11 |
--------------------------------------------------------------------------------
/app/tray_icon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/app/tray_icon.ico
--------------------------------------------------------------------------------
/app/tray_icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/app/tray_icon.png
--------------------------------------------------------------------------------
/app/tray_iconTemplate@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/app/tray_iconTemplate@2x.png
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: [
3 | '@babel/preset-typescript',
4 | [
5 | '@babel/preset-env', {
6 | /** Targets must match the versions supported by electron.
7 | * See https://www.electronjs.org/
8 | */
9 | targets: {
10 | node: '16',
11 | chrome: '102'
12 | }
13 | }
14 | ],
15 | '@babel/preset-react'
16 | ]
17 | }
18 |
--------------------------------------------------------------------------------
/build/icon.icns:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icon.icns
--------------------------------------------------------------------------------
/build/icon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icon.ico
--------------------------------------------------------------------------------
/build/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icon.png
--------------------------------------------------------------------------------
/build/icons/1024x1024.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/1024x1024.png
--------------------------------------------------------------------------------
/build/icons/128x128.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/128x128.png
--------------------------------------------------------------------------------
/build/icons/16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/16x16.png
--------------------------------------------------------------------------------
/build/icons/256x256.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/256x256.png
--------------------------------------------------------------------------------
/build/icons/32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/32x32.png
--------------------------------------------------------------------------------
/build/icons/48x48.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/48x48.png
--------------------------------------------------------------------------------
/build/icons/512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/icons/512x512.png
--------------------------------------------------------------------------------
/build/installer.nsh:
--------------------------------------------------------------------------------
1 | !macro customInstall
2 | DetailPrint "Register cerebro URI Handler"
3 | DeleteRegKey HKCR "cerebro"
4 | WriteRegStr HKCR "cerebro" "" "URL:cerebro"
5 | WriteRegStr HKCR "cerebro" "URL Protocol" ""
6 | WriteRegStr HKCR "cerebro\DefaultIcon" "" "$INSTDIR\${APP_EXECUTABLE_FILENAME}"
7 | WriteRegStr HKCR "cerebro\shell" "" ""
8 | WriteRegStr HKCR "cerebro\shell\Open" "" ""
9 | WriteRegStr HKCR "cerebro\shell\Open\command" "" "$INSTDIR\${APP_EXECUTABLE_FILENAME} %1"
10 | !macroend
11 |
--------------------------------------------------------------------------------
/build/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cerebroapp/cerebro/d6bd5f6b5a4decb3fce71ba09e2439e1ad036a24/build/logo.png
--------------------------------------------------------------------------------
/electron-builder.json:
--------------------------------------------------------------------------------
1 | {
2 | "productName": "Cerebro",
3 | "appId": "com.cerebroapp.Cerebro",
4 | "protocols": {
5 | "name": "Cerebro URLs",
6 | "role": "Viewer",
7 | "schemes": [
8 | "cerebro"
9 | ]
10 | },
11 | "directories": {
12 | "app": "./app",
13 | "output": "release"
14 | },
15 | "linux": {
16 | "target": [
17 | {
18 | "target": "deb",
19 | "arch": [
20 | "x64"
21 | ]
22 | },
23 | {
24 | "target": "AppImage",
25 | "arch": [
26 | "x64"
27 | ]
28 | }
29 | ],
30 | "category": "Utility"
31 | },
32 | "mac": {
33 | "category": "public.app-category.productivity"
34 | },
35 | "dmg": {
36 | "contents": [
37 | {
38 | "x": 410,
39 | "y": 150,
40 | "type": "link",
41 | "path": "/Applications"
42 | },
43 | {
44 | "x": 130,
45 | "y": 150,
46 | "type": "file"
47 | }
48 | ]
49 | },
50 | "win": {
51 | "target": [
52 | {
53 | "target": "nsis",
54 | "arch": [
55 | "x64",
56 | "ia32"
57 | ]
58 | },
59 | {
60 | "target": "portable",
61 | "arch": [
62 | "x64",
63 | "ia32"
64 | ]
65 | }
66 | ]
67 | },
68 | "nsis": {
69 | "include": "build/installer.nsh",
70 | "perMachine": true
71 | },
72 | "files": [
73 | "dist/",
74 | "main/index.html",
75 | "main/css,",
76 | "background/index.html",
77 | "tray_icon.png",
78 | "tray_icon.ico",
79 | "tray_iconTemplate@2x.png",
80 | "node_modules/",
81 | "app/node_modules/",
82 | "main.js",
83 | "main.js.map",
84 | "package.json",
85 | "!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme,test,__tests__,tests,powered-test,example,examples,*.d.ts}",
86 | "!**/node_modules/.bin",
87 | "!**/*.{o,hprof,orig,pyc,pyo,rbc}",
88 | "!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,__pycache__,thumbs.db,.gitignore,.gitattributes,.editorconfig,.flowconfig,.yarn-metadata.json,.idea,appveyor.yml,.travis.yml,circle.yml,npm-debug.log,.nyc_output,yarn.lock,.yarn-integrity}"
89 | ],
90 | "squirrelWindows": {
91 | "iconUrl": "https://raw.githubusercontent.com/cerebroapp/cerebro/master/build/icon.ico"
92 | },
93 | "publish": {
94 | "provider": "github",
95 | "vPrefixedTagName": true,
96 | "releaseType": "release"
97 | }
98 | }
99 |
--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | collectCoverage: true,
3 | moduleDirectories: ['node_modules', 'app'],
4 | moduleNameMapper: {
5 | '\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '