Skip to content

Commit

Permalink
chore(activate): Move command activate under test subcommand (#92)
Browse files Browse the repository at this point in the history
* chore(activate): Move command activate under test subcommand

* update doc

* Update test

* changelog

* Move the test infront
jcs090218 authored Jan 1, 2023
1 parent fa05a50 commit 172e9c2
Showing 6 changed files with 52 additions and 48 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -28,6 +28,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
* Acknowledge cleaning state for `clean all` command (#87)
* Fix keyword lint undetected (#88)
* Improve Eask-file loader to search file upward (#89)
* Move command `activate` under test subcommand (#92)

## 0.7.x
> Released Sep 08, 2022
2 changes: 1 addition & 1 deletion cmds/core/activate.js → cmds/test/activate.js
Original file line number Diff line number Diff line change
@@ -30,5 +30,5 @@ exports.builder = {
};

exports.handler = async (argv) => {
await UTIL.e_call(argv, 'core/activate', argv.files);
await UTIL.e_call(argv, 'test/activate', argv.files);
};
59 changes: 29 additions & 30 deletions docs/content/en/Getting Started/Basic Usage.md
Original file line number Diff line number Diff line change
@@ -27,21 +27,20 @@ Eask is a command-line tool that helps you build, lint, and test Emacs Lisp pack
Usage: eask <command> [options..]
Commands:
activate [files..] activate package; use to test package activation
archives list out all package archives [aliases: sources]
archives list out all package archives [aliases: sources]
autoloads generate autoloads file
clean <type> delete various files produced during building
compile [names..] byte compile all Emacs Lisp files in the package
concat [names..] concatenate all elisp files [aliases: concatenate]
create <name> create a new elisp project [aliases: new]
concat [names..] concatenate all elisp files [aliases: concatenate]
create <name> create a new elisp project [aliases: new]
emacs [args..] execute emacs with the appropriate environment
eval [form] evaluate lisp form with a proper PATH
path print the PATH (exec-path) from workspace [aliases: exec-path]
path print the PATH (exec-path) from workspace [aliases: exec-path]
exec [args..] execute command with correct environment PATH set up
files print the list of all package files
info display information about the current package
init create new Eask file in current directory
install-deps automatically install package dependencies [aliases: install-dependencies, prepare]
install-deps automatically install package dependencies [aliases: install-dependencies, prepare]
install [names..] install packages
keywords list available keywords that can be used in the header section
lint <type> run linter
@@ -55,39 +54,39 @@ Commands:
recipe suggest a recipe format
refresh download package archives
reinstall [names..] reinstall packages
run [names..] run the script named [names..] [aliases: run-script]
run [names..] run the script named [names..] [aliases: run-script]
search [queries..] search packages
test <type> run test
uninstall [names..] uninstall packages [aliases: delete]
uninstall [names..] uninstall packages [aliases: delete]
upgrade [names..] upgrade packages
check-eask [files..] run eask checker
locate print out Eask installed location
upgrade-eask upgrade Eask itself [aliases: upgrade-self]
upgrade-eask upgrade Eask itself [aliases: upgrade-self]
Proxy Options:
--proxy update proxy for HTTP and HTTPS to host [string]
--http-proxy update proxy for HTTP to host [string]
--https-proxy update proxy for HTTPS to host [string]
--no-proxy set no-proxy to host [string]
--proxy update proxy for HTTP and HTTPS to host [string]
--http-proxy update proxy for HTTP to host [string]
--https-proxy update proxy for HTTPS to host [string]
--no-proxy set no-proxy to host [string]
Options:
--version Show version number [boolean]
--help Show usage instructions [boolean]
-g, --global change default workspace to ~/.emacs.d/ [boolean]
-a, --all enable all flag [boolean]
-q, --quick start cleanly without loading the configuration files [boolean]
-f, --force enable force flag [boolean]
--development, --dev turn on development mode [boolean]
--debug turn on debug mode [boolean]
--strict report error instead of warnings [boolean]
--allow-error continue the executioon even there is error reported [boolean]
--insecure allow insecure connection [boolean]
--timestamps log with timestamps [boolean]
--log-level log with level [boolean]
--log-file, --lf generate log files [boolean]
--elapsed-time, --et show elapsed time between each operation [boolean]
--no-color disable color output [boolean]
-v, --verbose set verbosity from 0 to 4 [number]
--version Show version number [boolean]
--help Show usage instructions [boolean]
-g, --global change default workspace to ~/.emacs.d/ [boolean]
-a, --all enable all flag [boolean]
-q, --quick start cleanly without loading the configuration files [boolean]
-f, --force enable force flag [boolean]
--development, --dev turn on development mode [boolean]
--debug turn on debug mode [boolean]
--strict report error instead of warnings [boolean]
--allow-error continue the executioon even there is error reported [boolean]
--insecure allow insecure connection [boolean]
--timestamps log with timestamps [boolean]
--log-level log with level [boolean]
--log-file, --lf generate log files [boolean]
--elapsed-time, --et show elapsed time between each operation [boolean]
--no-color disable color output [boolean]
-v, --verbose set verbosity from 0 to 4 [number]
For more information, find the manual at https://emacs-eask.github.io/
```
28 changes: 14 additions & 14 deletions docs/content/en/Getting Started/Commands and options.md
Original file line number Diff line number Diff line change
@@ -225,20 +225,6 @@ Load Emacs Lisp files in order.
$ eask [GLOBAL-OPTIONS] load [FILES..]
```

## 🔍 eask activate

Activate package; use to test the package activation

```sh
$ eask [GLOBAL-OPTIONS] activate [FILES..]
```

{{< hint info >}}
💡 You can pass in **[FILES..]** so you can test your package activation fully!

**[FILES..]** will be loaded after the package is activated.
{{< /hint >}}

## 🔍 eask recipe

Suggest a recipe format
@@ -456,6 +442,20 @@ Alias: `lint relint`

# 🚩 Testing

## 🔍 eask test activate

Activate package; use to test the package activation

```sh
$ eask [GLOBAL-OPTIONS] activate [FILES..]
```

{{< hint info >}}
💡 You can pass in **[FILES..]** so you can test your package activation fully!

**[FILES..]** will be loaded after the package is activated.
{{< /hint >}}

## 🔍 eask test ert

```sh
6 changes: 4 additions & 2 deletions lisp/core/activate.el → lisp/test/activate.el
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;;; core/activate.el --- activate package -*- lexical-binding: t; -*-
;;; test/activate.el --- activate package -*- lexical-binding: t; -*-

;;; Commentary:
;;
@@ -21,6 +21,8 @@
(format "Activating the package `%s'... " (ansi-green name))
(require (intern name))
"succeeded ✓"))
;; XXX: Call `core/load' command to load the files for activation tests!
;; The command will parse the argument itself, so we don't have to worry!
(eask-call "core/load"))

;;; core/activate.el ends here
;;; test/activate.el ends here
4 changes: 3 additions & 1 deletion test/commands/local/run.sh
Original file line number Diff line number Diff line change
@@ -44,7 +44,6 @@ eask package

# Development
eask compile
eask activate
eask recipe
eask keywords
eask run
@@ -62,6 +61,9 @@ eask lint keywords
eask lint package
eask lint regexps

# Testing
eask test activate

# Clean up
eask clean .eask
eask clean elc

0 comments on commit 172e9c2

Please sign in to comment.