From 920f463fe4e1ab352cfbe8a29910ecb699eb27c3 Mon Sep 17 00:00:00 2001 From: chee Date: Fri, 11 Aug 2017 17:36:08 +0100 Subject: [PATCH] remove unused files and update readme --- CHANGELOG.md | 3 -- LICENSE.md | 2 +- README.md | 28 ++++++++++-- lib/camel-case-mode-view.js | 29 ------------- lib/camel-case-mode.js | 1 - menus/camel-case-mode.json | 4 +- package.json | 10 ++--- spec/camel-case-mode-spec.js | 72 +------------------------------ spec/camel-case-mode-view-spec.js | 9 ---- styles/camel-case-mode.less | 2 +- 10 files changed, 34 insertions(+), 126 deletions(-) delete mode 100644 CHANGELOG.md delete mode 100644 lib/camel-case-mode-view.js delete mode 100644 spec/camel-case-mode-view-spec.js diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index c3d858c..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,3 +0,0 @@ -## 0.1.0 - First Release -* Every feature added -* Every bug fixed diff --git a/LICENSE.md b/LICENSE.md index 1648869..f0da0fc 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2017 +copyright (c) 2017 chee Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index f9595a0..42ff9b4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,27 @@ -# camel-case-mode package +# camelCaseMode -A short description of your package. +press a key to enable *__camelCaseMode__*, which capitalises the letter pressed +after `space`. so like: -![A screenshot of your package](https://f.cloud.github.com/assets/69169/2290250/c35d867a-a017-11e3-86be-cd7c5bf3ff9b.gif) +pleasespacehelpspacemespacemrsspacejones comes out like `pleaseHelpMeMrsJones` + +you can press space again to get out of *__camelCaseMode__* + +can enable some kind of indication for yoself that you in camelCaseMode by way of + +```less +// styles.less +.camel-case-mode { + border: 1px solid #ff2a50; +} +``` + +(`.camel-case-mode` is set on `atom-text-editor`) + +## TODO + +* write tests +* deactivate on C-c, C-g, Esc +* apologise to everybody for everything i've ever done +* meet a princess and live in a castle +* or a prince diff --git a/lib/camel-case-mode-view.js b/lib/camel-case-mode-view.js deleted file mode 100644 index cb6e23d..0000000 --- a/lib/camel-case-mode-view.js +++ /dev/null @@ -1,29 +0,0 @@ -'use babel'; - -export default class CamelCaseModeView { - - constructor(serializedState) { - // Create root element - this.element = document.createElement('div'); - this.element.classList.add('camel-case-mode'); - - // Create message element - const message = document.createElement('div'); - message.textContent = 'The CamelCaseMode package is Alive! It\'s ALIVE!'; - message.classList.add('message'); - this.element.appendChild(message); - } - - // Returns an object that can be retrieved when package is activated - serialize() {} - - // Tear down any state and detach - destroy() { - this.element.remove(); - } - - getElement() { - return this.element; - } - -} diff --git a/lib/camel-case-mode.js b/lib/camel-case-mode.js index e6e28f5..cfbf436 100644 --- a/lib/camel-case-mode.js +++ b/lib/camel-case-mode.js @@ -4,7 +4,6 @@ import {CompositeDisposable} from 'atom' import {MODE_CLASS} from '../constants' export default { - camelCaseModeView: null, modalPanel: null, subscriptions: null, isEnabled: false, diff --git a/menus/camel-case-mode.json b/menus/camel-case-mode.json index 9c9822e..a2b6c5e 100644 --- a/menus/camel-case-mode.json +++ b/menus/camel-case-mode.json @@ -2,7 +2,7 @@ "context-menu": { "atom-text-editor": [ { - "label": "Toggle camel-case-mode", + "label": "Toggle camelCaseMode", "command": "camel-case-mode:toggle" } ] @@ -12,7 +12,7 @@ "label": "Packages", "submenu": [ { - "label": "camel-case-mode", + "label": "camelCaseMode", "submenu": [ { "label": "Toggle", diff --git a/package.json b/package.json index ccb25e4..b0b4937 100644 --- a/package.json +++ b/package.json @@ -2,17 +2,15 @@ "name": "camel-case-mode", "main": "./lib/camel-case-mode", "version": "0.0.0", - "description": "A short description of your package", - "keywords": [ - ], + "description": "type camel case words with space bar like normal word person", + "keywords": [], "activationCommands": { "atom-workspace": "camel-case-mode:toggle" }, - "repository": "https://github.com/atom/camel-case-mode", + "repository": "https://github.com/chee/camel-case-mode", "license": "MIT", "engines": { "atom": ">=1.0.0 <2.0.0" }, - "dependencies": { - } + "dependencies": {} } diff --git a/spec/camel-case-mode-spec.js b/spec/camel-case-mode-spec.js index 1db9065..a6ddf7f 100644 --- a/spec/camel-case-mode-spec.js +++ b/spec/camel-case-mode-spec.js @@ -1,73 +1,3 @@ 'use babel' -import CamelCaseMode from '../lib/camel-case-mode' - -// Use the command `window:run-package-specs` (cmd-alt-ctrl-p) to run specs. -// -// To run a specific `it` or `describe` block add an `f` to the front (e.g. `fit` -// or `fdescribe`). Remove the `f` to unfocus the block. - -describe('CamelCaseMode', () => { - let workspaceElement, activationPromise - - beforeEach(() => { - workspaceElement = atom.views.getView(atom.workspace) - activationPromise = atom.packages.activatePackage('camel-case-mode') - }) - - describe('when the camel-case-mode:toggle event is triggered', () => { - it('hides and shows the modal panel', () => { - // Before the activation event the view is not on the DOM, and no panel - // has been created - expect(workspaceElement.querySelector('.camel-case-mode')).not.toExist() - - // This is an activation event, triggering it will cause the package to be - // activated. - atom.commands.dispatch(workspaceElement, 'camel-case-mode:toggle') - - waitsForPromise(() => { - return activationPromise - }) - - runs(() => { - expect(workspaceElement.querySelector('.camel-case-mode')).toExist() - - let camelCaseModeElement = workspaceElement.querySelector('.camel-case-mode') - expect(camelCaseModeElement).toExist() - - let camelCaseModePanel = atom.workspace.panelForItem(camelCaseModeElement) - expect(camelCaseModePanel.isVisible()).toBe(true) - atom.commands.dispatch(workspaceElement, 'camel-case-mode:toggle') - expect(camelCaseModePanel.isVisible()).toBe(false) - }) - }) - - it('hides and shows the view', () => { - // This test shows you an integration test testing at the view level. - - // Attaching the workspaceElement to the DOM is required to allow the - // `toBeVisible()` matchers to work. Anything testing visibility or focus - // requires that the workspaceElement is on the DOM. Tests that attach the - // workspaceElement to the DOM are generally slower than those off DOM. - jasmine.attachToDOM(workspaceElement) - - expect(workspaceElement.querySelector('.camel-case-mode')).not.toExist() - - // This is an activation event, triggering it causes the package to be - // activated. - atom.commands.dispatch(workspaceElement, 'camel-case-mode:toggle') - - waitsForPromise(() => { - return activationPromise - }) - - runs(() => { - // Now we can test for view visibility - let camelCaseModeElement = workspaceElement.querySelector('.camel-case-mode') - expect(camelCaseModeElement).toBeVisible() - atom.commands.dispatch(workspaceElement, 'camel-case-mode:toggle') - expect(camelCaseModeElement).not.toBeVisible() - }) - }) - }) -}) +// TODO diff --git a/spec/camel-case-mode-view-spec.js b/spec/camel-case-mode-view-spec.js deleted file mode 100644 index 9b0c337..0000000 --- a/spec/camel-case-mode-view-spec.js +++ /dev/null @@ -1,9 +0,0 @@ -'use babel' - -import CamelCaseModeView from '../lib/camel-case-mode-view' - -describe('CamelCaseModeView', () => { - it('has one valid test', () => { - expect('life').toBe('easy') - }) -}) diff --git a/styles/camel-case-mode.less b/styles/camel-case-mode.less index 5f18c6b..5590391 100644 --- a/styles/camel-case-mode.less +++ b/styles/camel-case-mode.less @@ -5,5 +5,5 @@ @import "ui-variables"; .camel-case-mode { - border: 1px solid @text-color; + // border: 1px solid #ff2a50; }