Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/secretGeek/ok-ps

.ok folder profiles for Powershell
https://github.com/secretGeek/ok-ps

commands folder-profiles powershell

Last synced: about 1 month ago
JSON representation

.ok folder profiles for Powershell

Awesome Lists containing this project

README 

        
# ok-ps



## "ok" gives you .ok folder profiles for powershell



(There is also a [bash version](https://github.com/secretGeek/ok-bash/))



`ok` makes you smarter and more efficient.



Do you work on many different projects? And in each project, are there commands or URLs you use that are specific to that project? You need a `.ok` file.



A `.ok` file is a place to store any handy one-liners specific to the folder it is in. It can be viewed with a simple command. And commands in the `.ok` file can be executed immediately with the command `ok {number}` (example, `ok 3` to run the 3rd command.)



Imagine your `.ok` file contains these three lines:



    build.ps1 # builds the project

    deploy.ps1 # deploys the project

    commit_push.ps1 $arg[0] # commit with comment, rebase and push



A `.ok` file acts as a neat place to document how a given project works. This is useful if you have many projects, or many people working on a project. It's such a little file; it's quick to write, follows a [specification](#language-specification) (still in draft) and easy to edit.



But it's not just a document, it's executable.



If you run the command `ok` (with no parameters) you'll see the file listed, with numbers against each command:



    > ok

    1: build.ps1             # builds the project

    2: deploy.ps1            # deploys the project

    3: commit_push.ps1 $arg  # commit with comment, rebase and push



Then if you run `ok {number}` (ok followed by a number) you'll execute that line of the file.



	> ok 1

	> build.ps1 # builds the project

	building.....



And you can pass simple arguments to the commands. For example:



	> ok 3 Added laser guidance system

    > commit_push.ps1 $arg # commit with comment, rebase and push



	Committing with comment "Added laser guidance system"

	Commit succeeded.

	Rebase successful

	Pushing to master.



💡 Tip: "." (i.e. source) the "Invoke-OKCommand.ps1" script from your `$profile`, e.g:



    . .\Invoke-OKCommand.ps1



It will give you the `ok` command (which is really an alias to `Invoke-OK`)



## .ok file specification



An ok file consists of lines of text.



each line is finished by a line break, or an end of file marker.



each line either:



- starts with a '#' character - indicating it is a comment. (can be preceeded by whitespace - spaces, tabs etc.) for example:



        # This is a comment



- or starts with a "command name" followed by a colon, followed by a powershell one-liner. For example:



        build: .\build.ps1   # call `ok build` to run the command `.\build.ps1`



  - "A command name followed by a colon" is identified by this regex:



        [regex]$rx = "^[ `t]*(?[A-Za-z_][A-Za-z0-9-_.]*)[ `t]*\:(?.*)$";



- Or, if it matches neither of the above, it is treated as a pure powershell command. i.e. a powershell one liner. e.g.



        .\build.ps1 # execute this by calling `ok 1` (assuming it is the 1st line)



So there are two basic types of commands: named commands, and numbered commands. In fact, all commands are numbered, but if a command has a name, then the name is shown instead of the number.



For example, if this was your `.ok` file:



    build: build.ps1 # builds the project

    deploy.ps1 # deploys the project

    commit: commit_push.ps1 $arg[0]



Calling `ok` it would be displayed like this:



	build: build.ps1 # builds the project

		2: deploy.ps1 # deploys the project

		3: commit: commit_push.ps1 $arg[0]



And the first line could be called either with `ok build` or `ok 1`.



-----



## Running Unit tests



Powershell Unit tests rely on Pester 4+. Pester 3.4.0 is pre-installed on Windows 10.



	Install-Module -Name Pester -Force -SkipPublisherCheck



Run tests like this:



	ok test



Or



	Invoke-Pester



Or:



	Invoke-Pester -Script .\Get-OKCommandLength.Tests.ps1



## Running Invoke-ScriptAnalyzer



Requires the module `PSScriptAnalyzer` -- see [PS Gallery: PSScriptAnalyzer](https://www.powershellgallery.com/packages/PSScriptAnalyzer/)



	Install-Module -Name PSScriptAnalyzer



And can be executed like so:



	Invoke-ScriptAnalyzer *.ps1 -ExcludeRule PSAvoidUsingWriteHost | ft -auto



-----



See  for the blog post launching (and describing) "ok"