├── .github └── workflows │ └── check.yml ├── README.org ├── jest-traversal-test.el ├── jest-traversal.el ├── jest.el └── LICENSE /.github/workflows/check.yml: -------------------------------------------------------------------------------- 1 | name: check 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: 7 | - master 8 | 9 | jobs: 10 | check: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | fail-fast: false 14 | matrix: 15 | emacs_version: 16 | - 26.1 17 | - 26.2 18 | - 26.3 19 | ignore_warnings: 20 | - true 21 | include: 22 | - emacs_version: snapshot 23 | ignore_warnings: false 24 | steps: 25 | - uses: actions/checkout@v2 26 | - uses: purcell/setup-emacs@master 27 | with: 28 | version: ${{ matrix.emacs_version }} 29 | - uses: leotaku/elisp-check@master 30 | with: 31 | file: jest.el 32 | ignore_warnings: ${{ matrix.ignore_warnings }} 33 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: jest.el 2 | [[https://melpa.org/#/jest][file:https://melpa.org/packages/jest-badge.svg]] 3 | 4 | Credit: [[https://github.com/wbolster/emacs-python-pytest][emacs-python-pytest]] 5 | 6 | This package provides helpers to run jest. 7 | 8 | * Installation 9 | ~jest.el~ is available from melpa. 10 | 11 | With ~use-package~: 12 | #+BEGIN_SRC elisp 13 | (use-package jest) 14 | #+END_SRC 15 | Manually: 16 | #+BEGIN_SRC 17 | M-x package-install RET jest RET 18 | #+END_SRC 19 | * Overview 20 | The main command is jest-popup, which will show a 21 | dispatcher menu, making it easy to change various options and 22 | switches, and then run jest using one of the actions. 23 | - jest (run all tests) 24 | - jest-file (current file) 25 | - jest-file-dwim (‘Do what I mean’ for current file) 26 | - jest-function (the test function where the pointer is now, 27 | fallback to current file) 28 | - jest-last-failed (rerun previous failures) 29 | - jest-repeat (repeat last invocation) 30 | 31 | A prefix argument causes the generated command line to be offered 32 | for editing, and various customization options influence how some 33 | of the commands work. See the README.org for detailed information. 34 | 35 | * Jest Minor Mode 36 | Jest minor mode binds compilation-related commands such as =compile-command= and 37 | =recompile-command= to Jest commands, so that, for example =C-c = 38 | (=compile=) runs =jest-popup= and =C-c C-= (=recompile=) runs 39 | =jest-repeat=. The commands to run are configurable. 40 | 41 | #+begin_src el 42 | (use-package jest 43 | :after (js2-mode) 44 | :hook (js2-mode . jest-minor-mode)) 45 | #+end_src 46 | 47 | * Jest Popup 48 | #+BEGIN_SRC 49 | Switches 50 | -b bail (--bail) 51 | -c colors (--colors) 52 | -C coverage (--coverage) 53 | -d run doctests (--doctest-modules) 54 | -D debug jest config (--debug) 55 | -e expand (--expand) 56 | -f force exit (--forceExit) 57 | -l last commit (--lastCommit) 58 | -o only changed (--onlyChanged) 59 | -s silent (--silent) 60 | -v verbose (--verbose) 61 | -w watch (--watch) 62 | -W watch all (--watchAll) 63 | 64 | Options 65 | =c config file (--config=) 66 | =k only names matching expression (-t) 67 | =p only files matching expression (--testPathPattern ) 68 | =P only files not matching expression (--testPathIgnorePatterns ) 69 | =o output file (--outputFile=) 70 | =x exit after N failures or errors (--maxfail=) 71 | 72 | Run tests 73 | t Test all x Test last-failed 74 | 75 | Run tests for current context 76 | f Test file F Test this file 77 | d Test function 78 | 79 | Repeat tests 80 | r Repeat last test run 81 | #+END_SRC 82 | 83 | * Contributing 84 | Please create a [[https://github.com/Emiller88/emacs-jest/issues/new][new issue]] or [[https://github.com/Emiller88/emacs-jest/compare][submit a PR]]. 85 | -------------------------------------------------------------------------------- /jest-traversal-test.el: -------------------------------------------------------------------------------- 1 | (require 'traverse.el) 2 | (require 'ert) 3 | 4 | (ert-deftest jest-test--check-bracket () 5 | (should (equal nil (jest--check-open-bracket ?t))) 6 | (should (equal t (jest--check-open-bracket ?()))) 7 | 8 | (ert-deftest jest-test--check-quotes () 9 | (should (equal nil (jest--check-char-quote ?t))) 10 | (should (equal t (jest--check-char-quote ?')))) 11 | 12 | (ert-deftest jest-test--check-in-quotes () 13 | (should (equal nil (jest--is-in-quotes '()))) 14 | (should (equal nil (jest--is-in-quotes '((?{ 1))))) 15 | (should (equal t (jest--is-in-quotes '((?' 1)))))) 16 | 17 | (ert-deftest jest-test--check-bracket-pair () 18 | (should (equal nil (jest--check-bracket-pair ?\( ?a))) 19 | (should (equal nil (jest--check-bracket-pair ?\( ?}))) 20 | (should (equal t (jest--check-bracket-pair ?\( ?\))))) 21 | 22 | (ert-deftest jest-test--remove-folded-range () 23 | (should (equal "test text" (jest--remove-folded-range "test text"))) 24 | (should (equal "test ()" (jest--remove-folded-range "test ('text')"))) 25 | (should (equal "test ()" (jest--remove-folded-range "test (text)")))) 26 | 27 | 28 | (ert-deftest jest-test--remove-text-in-bracket () 29 | (should (equal "test () text" (jest--remove-folded-range "test (be removed) text"))) 30 | (should (equal "test {} text" (jest--remove-folded-range "test {be removed} text"))) 31 | (should (equal "test [] text" (jest--remove-folded-range "test [be removed] text"))) 32 | (should (equal "test <> text" (jest--remove-folded-range "test text")))) 33 | 34 | (ert-deftest jest-test--wont-remove-text-quotes () 35 | (should (equal "test '(hi)' text" (jest--remove-folded-range "test '(hi)' text"))) 36 | (should (equal "test \"\" text" (jest--remove-folded-range "test \"\" text"))) 37 | (should (equal "test `` text" (jest--remove-folded-range "test `` text")))) 38 | 39 | (ert-deftest jest-test--get-current-test-fun-param () 40 | (should (equal "hi" (jest--current-test-fun-param "\ndescribe('---', () => {}) \ntest('hi', () => {")))) 41 | 42 | (ert-deftest jest-test--get-describe-names () 43 | (should (equal "hi Joshua" (jest--current-describe-name "" "\ndescribe('hi', () => {}) \ndescribe('Joshua', () => {})"))) 44 | ;; FIXME: need to improved 45 | (should-not (equal "h'i Joshua" (jest--current-describe-name "" "\ndescribe('h\'i', () => {}) \ndescribe('Joshua', () => {})")))) 46 | 47 | (ert-deftest jest-test--get-describe-names-in-folded () 48 | (should (equal "Joshua" (jest--current-describe-name "" (jest--remove-folded-range "\ndescribe('hi', () => {}) \ndescribe('Joshua', () => {"))))) 49 | 50 | (ert-deftest jest-test--get-current-test-name () 51 | (should (equal "Joshua bye" (jest--current-test-name (jest--remove-folded-range "\ndescribe('hi', () => {}) \ndescribe('Joshua', () => { \nit('bye'"))))) 52 | -------------------------------------------------------------------------------- /jest-traversal.el: -------------------------------------------------------------------------------- 1 | (defconst jest--brackets '((?\( ?\)) (?{ ?}) (?\[ ?\]) (?< ?>))) 2 | (defconst jest--quotes '(?\' ?\" ?\`)) 3 | (defconst jest--blank-line-begin "^[\t\s]*") 4 | 5 | (defun jest--get-buffer-to-point () 6 | (buffer-substring 1 (line-end-position))) 7 | 8 | (defun jest--check-template (character substitutes cb) 9 | (let ((ele substitutes) (result nil)) 10 | (while ele 11 | (when (char-equal character (funcall cb ele)) 12 | (setq ele '()) 13 | (setq result t)) 14 | (setq ele (cdr ele))) 15 | result)) 16 | 17 | 18 | (defun jest--check-open-bracket (character) 19 | (jest--check-template character jest--brackets 20 | (lambda (ch) (car (car ch))))) 21 | 22 | (defun jest--check-close-bracket (character) 23 | (jest--check-template character jest--brackets 24 | (lambda (ch) (car (cdr (car ch)))))) 25 | 26 | (defun jest--check-bracket-pair (open close) 27 | (catch 'result 28 | (dolist (x jest--brackets) 29 | (when (and (char-equal open (car x)) 30 | (char-equal close (car (cdr x)))) 31 | (throw 'result t))))) 32 | 33 | (defun jest--check-char-quote (character) 34 | (jest--check-template character jest--quotes 35 | (lambda (ch) (car ch)))) 36 | 37 | (defun jest--is-in-quotes (stack) 38 | (if (car stack) 39 | (jest--check-char-quote (car (car stack))) 40 | nil)) 41 | 42 | (defun jest--merge-collapsed-range (list-to-del new-one) 43 | "compare the last input of list with new-one 44 | If collapse remove last one and push 45 | If not, just push" 46 | (if (and (car list-to-del) (>= (car (cdr (car list-to-del))) (car new-one))) 47 | (let () 48 | (jest--merge-collapsed-range (cdr list-to-del) new-one)) 49 | (if (null list-to-del) 50 | (list new-one) 51 | (push new-one list-to-del)))) 52 | 53 | (defun jest--remove-ranges (text list-to-del) 54 | (if (> (length list-to-del) 0) 55 | (let () 56 | (jest--remove-ranges (concat (substring text 0 (+ 1 (car (car list-to-del)))) 57 | (substring text (car (cdr (car list-to-del))))) 58 | (cdr list-to-del))) 59 | text)) 60 | 61 | ;; todo remove text closed with pairs but need to remain complete string 62 | ;; 1 : When meet Quotes. 63 | ;; If it's same quotes, pop from stack 64 | ; if not, Inside quotes ignore. If not inside quote, add to stack. 65 | ;; 2 : When meet bracket 66 | ;; If it's inside quotes, do nothing. 67 | ;; 2-1: If not inside quotes and opening braket 68 | ;; add to stack and record index. 69 | ;; 2-2: ... and closing braket 70 | ;; remove from stack and add list do delete with opening braket index. 71 | ;; If the last inserted in list is collapsed with current one, remove last one and add. 72 | (defun jest--remove-folded-range (text) 73 | (let ((stack '()) 74 | (list-to-del '()) 75 | (edited text)) 76 | (dotimes (i (length text)) 77 | (let ((ch (c-int-to-char (aref text i)))) 78 | (cond 79 | ((jest--check-char-quote ch) 80 | (if (jest--is-in-quotes stack) 81 | (when (char-equal (car (car stack)) ch) 82 | (setq stack (cdr stack))) 83 | (push (list ch i) stack))) 84 | ((jest--check-open-bracket ch) 85 | (when (not (jest--is-in-quotes stack)) 86 | (push (list ch i) stack))) 87 | ((and (jest--check-close-bracket ch) 88 | (jest--check-bracket-pair (car (car stack)) ch)) 89 | (when (not (jest--is-in-quotes stack)) 90 | (setq list-to-del 91 | (jest--merge-collapsed-range list-to-del 92 | (list (car (cdr (car stack))) i))) 93 | (setq stack (cdr stack))))))) 94 | (jest--remove-ranges text list-to-del))) 95 | 96 | 97 | (defun jest--current-describe-name (desc-names text) 98 | (if (or (string-match (concat jest--blank-line-begin "describe\(\'\\(.*?\\)\'") text) 99 | (string-match (concat jest--blank-line-begin "describe\(\"\\(.*?\\)\"") text)) 100 | (let ((describe-name (match-string 1 text))) 101 | (jest--current-describe-name (if (> (length desc-names) 0) 102 | (concat desc-names " " describe-name) 103 | describe-name) 104 | (substring text (match-beginning 1)))) 105 | desc-names)) 106 | 107 | (defun jest--current-test-fun-param (text) 108 | (when (or (string-match (concat jest--blank-line-begin "\\(test\\|it\\)\(\'\\(.*?\\)\'") text) 109 | (string-match (concat jest--blank-line-begin "\\(test\\|it\\)\(\"\\(.*?\\)\"") text)) 110 | (match-string 2 text))) 111 | 112 | (defun jest--current-test-name () 113 | (let ((text (jest--get-buffer-to-point))) 114 | (let ((refined (jest--remove-folded-range text))) 115 | (let ((desc-names (jest--current-describe-name "" refined))) 116 | (concat (when (> (length desc-names) 0) 117 | (concat desc-names " ")) 118 | (jest--current-test-fun-param refined)))))) 119 | 120 | (provide 'jest-traversal) 121 | -------------------------------------------------------------------------------- /jest.el: -------------------------------------------------------------------------------- 1 | ;;; jest.el --- helpers to run jest -*- lexical-binding: t; -*- 2 | ;; Author: Edmund Miller 3 | ;; URL: https://github.com/emiller88/emacs-jest/ 4 | ;; Version: 0.1.0 5 | ;; Keywords: jest, javascript, testing 6 | ;; Package-Requires: ((emacs "24.4") (dash "2.18.0") (magit-popup "2.12.0") (projectile "0.14.0") (s "1.12.0") (js2-mode "20180301") (cl-lib "0.6.1")) 7 | 8 | ;; This file is part of GNU Emacs. 9 | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation, either version 3 of the License, or 13 | ;; (at your option) any later version. 14 | 15 | ;; GNU Emacs is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with GNU Emacs. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; This package provides helpers to run jest. 26 | ;; 27 | ;; The main command is jest-popup, which will show a 28 | ;; dispatcher menu, making it easy to change various options and 29 | ;; switches, and then run jest using one of the actions. 30 | ;; - jest (run all tests) 31 | ;; - jest-file (current file) 32 | ;; - jest-file-dwim (‘do what i mean’ for current file) 33 | ;; - jest-last-failed (rerun previous failures) 34 | ;; - jest-repeat (repeat last invocation) 35 | ;; 36 | ;; A prefix argument causes the generated command line to be offered 37 | ;; for editing, and various customization options influence how some 38 | ;; of the commands work. See the README.org for detailed information. 39 | 40 | ;;; Code: 41 | (require 'comint) 42 | (require 'compile) 43 | (require 'js2-mode) 44 | 45 | (require 'dash) 46 | (require 'magit-popup) 47 | (require 'projectile) 48 | (require 's) 49 | (require 'jest-traversal) 50 | 51 | (defgroup jest nil 52 | "jest integration" 53 | :group 'js 54 | :prefix "jest-") 55 | 56 | (defcustom jest-confirm nil 57 | "Whether to edit the command in the minibuffer before execution. 58 | 59 | By default, jest will be executed without showing a minibuffer prompt. 60 | This can be changed on a case by case basis by using a prefix argument 61 | \(\\[universal-argument]\) when invoking a command. 62 | 63 | When t, this toggles the behaviour of the prefix argument." 64 | :group 'jest 65 | :type 'boolean) 66 | 67 | (defcustom jest-executable "npm test --" 68 | "The name of the jest executable." 69 | :group 'jest 70 | :type 'string) 71 | 72 | (defcustom jest-setup-hook nil 73 | "Hooks to run before a jest process starts." 74 | :group 'jest 75 | :type 'hook) 76 | 77 | (defcustom jest-started-hook nil 78 | "Hooks to run after a jest process starts." 79 | :group 'jest 80 | :type 'hook) 81 | 82 | (defcustom jest-finished-hook nil 83 | "Hooks to run after a jest process finishes." 84 | :group 'jest 85 | :type 'hook) 86 | 87 | (defcustom jest-buffer-name "*jest*" 88 | "Name of the jest output buffer." 89 | :group 'jest 90 | :type 'string) 91 | 92 | (defcustom jest-project-name-in-buffer-name t 93 | "Whether to include the project name in the buffer name. 94 | 95 | This is useful when working on multiple projects simultaneously." 96 | :group 'jest 97 | :type 'boolean) 98 | 99 | ;; TODO Find JS cli debugger 100 | (defcustom jest-pdb-track t 101 | "Whether to automatically track output when pdb is spawned. 102 | 103 | This results in automatically opening source files during debugging." 104 | :group 'jest 105 | :type 'boolean) 106 | 107 | (defcustom jest-strict-test-name-matching nil 108 | "Whether to require a strict match for the ‘test this function’ heuristic. 109 | 110 | This influences the ‘test this function’ behaviour when editing a 111 | non-test function, e.g. ‘foo()’. 112 | 113 | When nil (the default), the current function name will be used as 114 | a pattern to run the corresponding tests, which will match 115 | ‘test_foo()’ as well as ‘test_foo_xyz()’. 116 | 117 | When non-nil only ‘test_foo()’ will match, and nothing else." 118 | :group 'jest 119 | :type 'boolean) 120 | 121 | (defcustom jest-unsaved-buffers-behavior 'ask-all 122 | "Whether to ask whether unsaved buffers should be saved before running jest." 123 | :group 'jest 124 | :type '(choice (const :tag "Ask for all project buffers" ask-all) 125 | (const :tag "Ask for current buffer" ask-current) 126 | (const :tag "Save all project buffers" save-all) 127 | (const :tag "Save current buffer" save-current) 128 | (const :tag "Ignore" nil))) 129 | 130 | (defvar jest--history nil 131 | "History for jest invocations.") 132 | 133 | (defvar jest--project-last-command (make-hash-table :test 'equal) 134 | "Last executed command lines, per project.") 135 | 136 | (defvar-local jest--current-command nil 137 | "Current command; used in jest-mode buffers.") 138 | 139 | (fmakunbound 'jest-popup) 140 | (makunbound 'jest-popup) 141 | 142 | ;;;###autoload (autoload 'jest-popup "jest" nil t) 143 | (magit-define-popup jest-popup 144 | "Show popup for running jest." 145 | 'jest 146 | :switches 147 | '((?b "bail" "--bail") 148 | (?c "colors" "--colors" t) 149 | (?C "coverage" "--coverage") 150 | (?d "run doctests" "--doctest-modules") 151 | (?D "debug jest config" "--debug") 152 | (?e "expand" "--expand") 153 | (?f "force exit" "--forceExit") 154 | (?l "last commit" "--lastCommit") 155 | ;; (?p "debug on error" "--pdb") 156 | (?o "only changed" "--onlyChanged") 157 | (?s "silent" "--silent") 158 | ;; (?s "do not capture output" "--capture=no") 159 | ;; (?t "do not cut tracebacks" "--full-trace") 160 | (?v "verbose" "--verbose") 161 | ;;--watch 162 | (?w "watch" "--watch") 163 | (?W "watch all" "--watchAll")) 164 | :options 165 | '((?c "config file" "--config=") 166 | (?k "only names matching expression" "-t") 167 | (?p "only files matching expression" "--testPathPattern ") 168 | (?P "only files not matching expression" "--testPathIgnorePatterns ") 169 | ;; (?m "only marks matching expression" "-m") 170 | (?o "output file" "--outputFile=") 171 | ;; (?t "traceback style" "--tb=" jest--choose-traceback-style) 172 | (?x "exit after N failures or errors" "--maxfail=")) 173 | :actions 174 | '("Run tests" 175 | (?t "Test all" jest) 176 | (?x "Test last-failed" jest-last-failed) 177 | "Run tests for current context" 178 | (?f "Test file" jest-file-dwim) 179 | (?F "Test this file " jest-file) 180 | (?d "Test function " jest-function) 181 | "Repeat tests" 182 | (?r "Repeat last test run" jest-repeat)) 183 | :max-action-columns 2 184 | :default-action 'jest-repeat) 185 | 186 | ;;;###autoload 187 | (defun jest (&optional args) 188 | "Run jest with ARGS. 189 | 190 | With a prefix argument, allow editing." 191 | (interactive (list (jest-arguments))) 192 | (jest--run 193 | :args args 194 | :edit current-prefix-arg)) 195 | 196 | ;;;###autoload 197 | (defun jest-file (file &optional args) 198 | "Run jest on FILE, using ARGS. 199 | 200 | Additional ARGS are passed along to jest. 201 | With a prefix argument, allow editing." 202 | (interactive 203 | (list 204 | (buffer-file-name) 205 | (jest-arguments))) 206 | (jest--run 207 | :args args 208 | :file file 209 | :edit current-prefix-arg)) 210 | 211 | ;;;###autoload 212 | (defun jest-file-dwim (file &optional args) 213 | "Run jest on FILE, intelligently finding associated test modules. 214 | 215 | When run interactively, this tries to work sensibly using 216 | the current file. 217 | 218 | Additional ARGS are passed along to jest. 219 | With a prefix argument, allow editing." 220 | (interactive 221 | (list 222 | (buffer-file-name) 223 | (jest-arguments))) 224 | (jest-file (jest--sensible-test-file file) args)) 225 | 226 | 227 | ;;;###autoload 228 | (defun jest-function (file testname &optional args) 229 | "Run jest on the test function where pointer is located. 230 | 231 | When pointer is not inside a test function jest is run on the whole file." 232 | (interactive 233 | (list (buffer-file-name) (jest--current-test-name) (jest-arguments))) 234 | (jest--run 235 | :args args 236 | :file file 237 | :testname testname)) 238 | 239 | 240 | ;;;###autoload 241 | (defun jest-last-failed (&optional args) 242 | "Run jest, only executing previous test failures. 243 | 244 | Additional ARGS are passed along to jest. 245 | With a prefix argument, allow editing." 246 | (interactive (list (jest-arguments))) 247 | (jest--run 248 | :args (-snoc args "--last-failed") 249 | :edit current-prefix-arg)) 250 | 251 | ;;;###autoload 252 | (defun jest-repeat () 253 | "Run jest with the same argument as the most recent invocation. 254 | 255 | With a prefix ARG, allow editing." 256 | (interactive) 257 | (let ((command (gethash 258 | (jest--project-root) 259 | jest--project-last-command))) 260 | (when jest--current-command 261 | ;; existing jest-mode buffer; reuse command 262 | (setq command jest--current-command)) 263 | (unless command 264 | (user-error "No previous jest run for this project")) 265 | (jest--run-command 266 | :command command 267 | :popup-arguments jest-arguments 268 | :edit current-prefix-arg))) 269 | 270 | 271 | ;; internal helpers 272 | 273 | (fmakunbound 'jest-mode) 274 | (makunbound 'jest-mode) 275 | 276 | (define-derived-mode jest-mode 277 | comint-mode "jest" 278 | "Major mode for jest sessions (derived from comint-mode)." 279 | (make-variable-buffer-local 'comint-prompt-read-only) 280 | (setq-default comint-prompt-read-only nil) 281 | (compilation-setup t)) 282 | 283 | (cl-defun jest--run (&key args file testname edit) 284 | "Run jest for the given arguments." 285 | (let ((popup-arguments args) 286 | command) 287 | (setq args (jest--transform-arguments args)) 288 | (when (and file (file-name-absolute-p file)) 289 | (setq file (jest--relative-file-name file))) 290 | 291 | (when file 292 | (setq args (-snoc args (jest--shell-quote file)))) 293 | (when testname 294 | (setq args (-snoc args "--testNamePattern" (jest--shell-quote testname)))) 295 | 296 | (setq args (cons jest-executable args) command (s-join " " args)) 297 | 298 | (jest--run-command 299 | :command command 300 | :popup-arguments popup-arguments 301 | :edit edit))) 302 | 303 | (cl-defun jest--run-command (&key command popup-arguments edit) 304 | "Run a jest command line." 305 | (jest--maybe-save-buffers) 306 | (let* ((default-directory (jest--project-root))) 307 | (when jest-confirm 308 | (setq edit (not edit))) 309 | (when edit 310 | (setq command 311 | (read-from-minibuffer 312 | "Command: " 313 | command nil nil 'jest--history))) 314 | (add-to-history 'jest--history command) 315 | (setq jest--history (-uniq jest--history)) 316 | (puthash (jest--project-root) command 317 | jest--project-last-command) 318 | (jest--run-as-comint 319 | :command command 320 | :popup-arguments popup-arguments))) 321 | 322 | (cl-defun jest--run-as-comint (&key command popup-arguments) 323 | "Run a jest comint session for COMMAND." 324 | (let* ((buffer (jest--get-buffer)) 325 | (process (get-buffer-process buffer))) 326 | (with-current-buffer buffer 327 | (when (comint-check-proc buffer) 328 | (unless (or compilation-always-kill 329 | (yes-or-no-p "Kill running jest process?")) 330 | (user-error "Aborting; jest still running"))) 331 | (when process 332 | (delete-process process)) 333 | (erase-buffer) 334 | (unless (eq major-mode 'jest-mode) 335 | (jest-mode)) 336 | (compilation-forget-errors) 337 | (insert (format "cwd: %s\ncmd: %s\n\n" default-directory command)) 338 | (make-local-variable 'jest-arguments) 339 | (setq jest--current-command command 340 | jest-arguments popup-arguments) 341 | (run-hooks 'jest-setup-hook) 342 | (make-comint-in-buffer "jest" buffer "sh" nil "-c" command) 343 | (run-hooks 'jest-started-hook) 344 | (setq process (get-buffer-process buffer)) 345 | (set-process-sentinel process #'jest--process-sentinel) 346 | (display-buffer buffer)))) 347 | 348 | (defun jest--shell-quote (s) 349 | "Quote S for use in a shell command. Like `shell-quote-argument', but prettier." 350 | (if (s-equals-p s (shell-quote-argument s)) 351 | s 352 | (format "'%s'" (s-replace "'" "'\"'\"'" s)))) 353 | 354 | (defun jest--get-buffer () 355 | "Get a create a suitable compilation buffer." 356 | (magit-with-pre-popup-buffer 357 | (if (eq major-mode 'jest-mode) 358 | (current-buffer) ;; re-use buffer 359 | (let ((name jest-buffer-name)) 360 | (when jest-project-name-in-buffer-name 361 | (setq name (format "%s<%s>" name (jest--project-name)))) 362 | (get-buffer-create name))))) 363 | 364 | (defun jest--process-sentinel (proc _state) 365 | "Process sentinel helper to run hooks after PROC finishes." 366 | (with-current-buffer (process-buffer proc) 367 | (run-hooks 'jest-finished-hook))) 368 | 369 | (defun jest--transform-arguments (args) 370 | "Transform ARGS so that jest understands them." 371 | (--> 372 | args 373 | (jest--switch-to-option it "--color" "--color=yes" "--color=no") 374 | (jest--quote-string-option it "-k") 375 | (jest--quote-string-option it "-m"))) 376 | 377 | (defun jest--switch-to-option (args name on-replacement off-replacement) 378 | "Look in ARGS for switch NAME and turn it into option with a value. 379 | 380 | When present ON-REPLACEMENT is substituted, else OFF-REPLACEMENT is appended." 381 | (if (-contains-p args name) 382 | (-replace name on-replacement args) 383 | (-snoc args off-replacement))) 384 | 385 | (defun jest--quote-string-option (args option) 386 | "Quote all values in ARGS with the prefix OPTION as shell strings." 387 | (--map-when 388 | (s-prefix-p option it) 389 | (let ((s it)) 390 | (--> s 391 | (substring it (length option)) 392 | (s-trim it) 393 | (jest--shell-quote it) 394 | (format "%s %s" option it))) 395 | args)) 396 | 397 | (defun jest--choose-traceback-style (prompt _value) 398 | "Helper to choose a jest traceback style using PROMPT." 399 | (completing-read 400 | prompt '("long" "short" "line" "native" "no") nil t)) 401 | 402 | 403 | (defun jest--make-test-name (func) 404 | "Turn function name FUNC into a name (hopefully) matching its test name. 405 | 406 | Example: ‘MyABCThingy.__repr__’ becomes ‘test_my_abc_thingy_repr’." 407 | (--> 408 | func 409 | (s-replace "." "_" it) 410 | (s-snake-case it) 411 | (s-replace-regexp "_\+" "_" it) 412 | (s-chop-suffix "_" it) 413 | (s-chop-prefix "_" it) 414 | (format "test_%s" it))) 415 | 416 | 417 | ;; file/directory helpers 418 | 419 | (defun jest--read-package-json (file) 420 | "File to read package json for a project" 421 | (json-parse-string (with-temp-buffer 422 | (insert-file-contents (jest--find-package-json file)) 423 | (buffer-string)))) 424 | 425 | (defun jest--file-search-upward (directory file) 426 | "Search DIRECTORY for FILE and return its full path if found, or NIL if not. 427 | 428 | If FILE is not found in DIRECTORY, the parent of DIRECTORY will be searched." 429 | (let ((parent-dir (file-truename (concat (file-name-directory directory) "../"))) 430 | (current-path (if (not (string= (substring directory (- (length directory) 1)) "/")) 431 | (concat directory "/" file) 432 | (concat directory file)))) 433 | (if (file-exists-p current-path) 434 | current-path 435 | (when (and (not (string= (file-truename directory) parent-dir)) 436 | (< (length parent-dir) (length (file-truename directory)))) 437 | (jest--file-search-upward parent-dir file))))) 438 | 439 | (defun jest--find-package-json (file) 440 | "Find the package.json associated with a given file" 441 | (jest--file-search-upward (file-name-directory file) "package.json")) 442 | 443 | (defun jest--project-name () 444 | "Find the project name." 445 | (gethash "name" (jest--read-package-json buffer-file-name))) 446 | 447 | (defun jest--project-root () 448 | "Find the project root directory." 449 | (interactive) 450 | (file-name-directory (jest--find-package-json buffer-file-name))) 451 | 452 | (defun jest--relative-file-name (file) 453 | "Make FILE relative to the project root." 454 | ;; Note: setting default-directory gives different results 455 | ;; than providing a second argument to file-relative-name. 456 | (let ((default-directory (jest--project-root))) 457 | (file-relative-name file))) 458 | 459 | (defun jest--test-file-p (file) 460 | "Tell whether FILE is a test file." 461 | (projectile-test-file-p file)) 462 | 463 | (defun jest--find-test-file (file) 464 | "Find a test file associated to FILE, if any." 465 | (let ((test-file (projectile-find-matching-test file))) 466 | (unless test-file 467 | (user-error "No test file found")) 468 | test-file)) 469 | 470 | (defun jest--sensible-test-file (file) 471 | "Return a sensible test file name for FILE." 472 | (if (jest--test-file-p file) 473 | (jest--relative-file-name file) 474 | (jest--find-test-file file))) 475 | 476 | (defun jest--maybe-save-buffers () 477 | "Maybe save modified buffers." 478 | (cond 479 | ((memq jest-unsaved-buffers-behavior '(ask-current save-current)) 480 | ;; check only current buffer 481 | (when (and (buffer-modified-p) 482 | (or (eq jest-unsaved-buffers-behavior 'save-current) 483 | (y-or-n-p 484 | (format "Save modified buffer (%s)? " (buffer-name))))) 485 | (save-buffer))) 486 | ((memq jest-unsaved-buffers-behavior '(ask-all save-all)) 487 | ;; check all project buffers 488 | (-when-let* 489 | ((buffers 490 | (projectile-buffers-with-file (projectile-project-buffers))) 491 | (modified-buffers 492 | (-filter 'buffer-modified-p buffers)) 493 | (confirmed 494 | (or (eq jest-unsaved-buffers-behavior 'save-all) 495 | (y-or-n-p 496 | (format "Save modified project buffers (%d)? " 497 | (length modified-buffers)))))) 498 | (--each modified-buffers 499 | (with-current-buffer it 500 | (save-buffer))))) 501 | (t nil))) 502 | 503 | 504 | ;; functions to inspect/navigate the javascript source code 505 | (defun jest--current-testname () 506 | "Return the testname where pointer is located. 507 | 508 | Testname is defined by enclosing ~describe~ calls and ~it~/~test~ calls." 509 | (let* ((calls (jest--list-named-calls-upwards)) 510 | (testname "")) 511 | (dolist (call calls) 512 | ;; call is the node for the function, function name must be extracted 513 | ;; from its target node 514 | (let ((funcname (js2-name-node-name (js2-call-node-target call)))) 515 | (when (member funcname '("it" "test" "describe")) 516 | (let ((funcparam (jest--function-first-param-string call))) 517 | (setq testname (format "%s %s" funcparam testname)))))) 518 | (unless (string= testname "") (string-trim testname)))) 519 | 520 | 521 | 522 | (defun jest--list-named-calls-upwards () 523 | "List functions call nodes where function has a name. 524 | 525 | This goes from pointer position upwards." 526 | (save-excursion 527 | ;; enter the test function if the point is before it 528 | ;; separated only by whitespace, e.g. 529 | (skip-chars-forward "[:blank:]") 530 | (let* ((nodes ()) 531 | (node (js2-node-at-point))) 532 | (while (not (js2-ast-root-p node)) 533 | (when (js2-call-node-p node) 534 | (let ((target (js2-call-node-target node))) 535 | (when (js2-name-node-p target) 536 | (setq nodes (append nodes (list node)))))) 537 | (setq node (js2-node-parent node))) 538 | nodes))) 539 | 540 | (defun jest--function-first-param-string (node) 541 | "Get the first param from the function call" 542 | (let ((first-param (car (js2-call-node-args node)))) 543 | (when (js2-string-node-p first-param) 544 | (js2-string-node-value first-param)))) 545 | 546 | (defun jest-clear-buffer-after-test-end (inserted-string) 547 | (let 548 | ((test-end-regex ".*?Test Suites:.+\nTests: .+\nSnapshots: .+\nTime: .+\nRan all test suites.+\n.*?")) 549 | (when (and (s-contains? "*jest*" 550 | (buffer-name)) 551 | (s-matches? test-end-regex (buffer-string))) 552 | (beginning-of-buffer) 553 | (comint-clear-buffer)) 554 | inserted-string)) 555 | 556 | 557 | (add-hook 'comint-preoutput-filter-functions #'jest-clear-buffer-after-test-end) 558 | 559 | ;; 560 | 561 | (defcustom jest-compile-command 'jest-popup 562 | "Command to run when compile and friends are called." 563 | :group 'jest 564 | :type 'function) 565 | 566 | (defcustom jest-repeat-compile-command 'jest-repeat 567 | "Command to run when recompile and friends are called." 568 | :group 'jest 569 | :type 'function) 570 | 571 | ;;;###autoload 572 | (define-minor-mode jest-minor-mode 573 | "Minor mode to run jest-mode commands for compile and friends." 574 | :lighter " Jest" 575 | :keymap (let ((jest-minor-mode-keymap (make-sparse-keymap))) 576 | (define-key jest-minor-mode-keymap [remap compile] jest-compile-command) 577 | (define-key jest-minor-mode-keymap [remap recompile] jest-repeat-compile-command) 578 | (define-key jest-minor-mode-keymap [remap projectile-test-project] jest-compile-command) 579 | (define-key jest-minor-mode-keymap (kbd "C-c ;") 'jest-file-dwim) 580 | jest-minor-mode-keymap)) 581 | 582 | (provide 'jest) 583 | ;;; jest.el ends here 584 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------