mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 06:30:08 +02:00
plugin changes to support script plugins (#2315)
* plugin changes to support script plugins * all platforms can have plugins with file extensions * added .cmd, .py, .ps1 for windows * added more trace! statements to document request and response * WIP * pretty much working, need to figure out sink plugins * added a home for scripting plugin examples, ran fmt * Had a visit with my good friend Clippy. We're on speaking terms again. * add viable plugin extensions * clippy * update to load plugins without extension in *nix/mac. * fmt
This commit is contained in:
Darren Schroeder
GitHub
261
docs/sample_plugins/powershell/nu_plugin_mylen_filter.ps1
Normal file
261
docs/sample_plugins/powershell/nu_plugin_mylen_filter.ps1
Normal file
@ -0,0 +1,261 @@
|
||||
#!/usr/bin/env pwsh
|
||||
|
||||
# Created to demonstrate how to create a plugin with PowerShell
|
||||
# Below is a list of other links to help with scripting language plugin creation
|
||||
# https://vsoch.github.io/2019/nushell-plugin-golang/
|
||||
# Go https://github.com/vsoch/nushell-plugin-len
|
||||
# Python https://github.com/vsoch/nushell-plugin-python
|
||||
# Python https://github.com/vsoch/nushell-plugin-pokemon
|
||||
# C# https://github.com/myty/nu-plugin-lib
|
||||
# Ruby https://github.com/andrasio/nu_plugin
|
||||
|
||||
# WIP 8/19/20
|
||||
|
||||
# def print_good_response(response):
|
||||
# json_response = {"jsonrpc": "2.0", "method": "response", "params": {"Ok": response}}
|
||||
# print(json.dumps(json_response))
|
||||
# sys.stdout.flush()
|
||||
|
||||
function print_good_response {
|
||||
param($response)
|
||||
$json_response = @"
|
||||
{"jsonrpc": "2.0", "method": "response", "params": {"Ok": $($response)}}
|
||||
"@
|
||||
Write-Host $json_response
|
||||
}
|
||||
|
||||
# def get_length(string_value):
|
||||
# string_len = len(string_value["item"]["Primitive"]["String"])
|
||||
# int_item = {"Primitive": {"Int": string_len}}
|
||||
# int_value = string_value
|
||||
# int_value["item"] = int_item
|
||||
# return int_value
|
||||
|
||||
# functino get_length {
|
||||
# param($string_val)
|
||||
# $string_len = $string_val[`"item`"][`"Primitive`"][`"String`"].Length
|
||||
# }
|
||||
|
||||
function config {
|
||||
param ($json_rpc)
|
||||
#Write-Host $json_rpc
|
||||
|
||||
$response = '{ "jsonrpc": "2.0", "method": "response", "params": { "Ok": { "name": "mylen", "usage": "Return the length of a string", "positional": [], "rest_positional": null, "named": {}, "is_filter": true } } }'
|
||||
Write-Host $response
|
||||
return
|
||||
}
|
||||
|
||||
function begin_filter {
|
||||
$response = '{"jsonrpc":"2.0","method":"response","params":{"Ok":[]}}'
|
||||
Write-Host $response
|
||||
return
|
||||
}
|
||||
|
||||
function run_filter {
|
||||
param($input_data)
|
||||
# param(
|
||||
# [Parameter(
|
||||
# # Position = 0,
|
||||
# Mandatory = $true,
|
||||
# ValueFromPipeline = $true,
|
||||
# ValueFromPipelineByPropertyName = $true)
|
||||
# ]
|
||||
# [Alias('piped')]
|
||||
# [String]$piped_input
|
||||
# )
|
||||
|
||||
# param([string]$params)
|
||||
# {"method":"filter", "params": {"item": {"Primitive": {"String": "oogabooga"}}, \
|
||||
# "tag":{"anchor":null,"span":{"end":10,"start":12}}}}
|
||||
# Write-Error $piped_input
|
||||
Write-TraceMessage "PIPED" $input_data
|
||||
|
||||
$prim = "Primitive"
|
||||
$method = $input_data | Select-Object "method"
|
||||
$params = $input_data.params
|
||||
$primitive = $input_data.params.value.$prim
|
||||
$prim_type = ""
|
||||
$len = 0
|
||||
|
||||
if (![String]::IsNullOrEmpty($input_data)) {
|
||||
Write-TraceMessage "FJSON" $input_data
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($method)) {
|
||||
Write-TraceMessage "FMETHOD" $method
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($params)) {
|
||||
Write-TraceMessage "FPARAMS" $params
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($primitive)) {
|
||||
Write-TraceMessage "FPRIMITIVE" $primitive
|
||||
# $prim_type = $primitive | Get-Member -MemberType NoteProperty | Select-Object Name
|
||||
# switch ($prim_type.Name) {
|
||||
# 'String' { $data.params.value.$prim.String }
|
||||
# 'Int' { $data.params.value.$prim.Int }
|
||||
# Default { "none-found" }
|
||||
# }
|
||||
}
|
||||
|
||||
$prim_type = $primitive | Get-Member -MemberType NoteProperty | Select-Object Name
|
||||
switch ($prim_type.Name) {
|
||||
'String' { $len = $input_data.params.value.$prim.String.Length }
|
||||
'Int' { $input_data.params.value.$prim.Int }
|
||||
Default { $len = 0 }
|
||||
}
|
||||
|
||||
#Fake it til you make it
|
||||
# $response = '{ "jsonrpc": "2.0", "method": "response", "params": { "Ok": [ { "Ok": { "Value": { "value": { "Primitive": { "Int": 9 } }, "tag": { "anchor": null, "span": { "end": 2, "start": 0 } } } } } ] } }'
|
||||
# Write-Host $response
|
||||
# $response = '{ "jsonrpc": "2.0", "method": "response", "params": { "Ok": [ { "Ok": { "Value": { "value": { "Primitive": { "Int": 3 } }, "tag": { "anchor": null, "span": { "start": 0, "end": 2 } } } } } ] } }'
|
||||
# Write-Host $response
|
||||
|
||||
$json_obj = [ordered]@{
|
||||
jsonrpc = "2.0"
|
||||
method = "response"
|
||||
params = [ordered]@{
|
||||
Ok = @(
|
||||
[ordered]@{
|
||||
Ok = [ordered]@{
|
||||
Value = [ordered]@{
|
||||
value = [ordered]@{
|
||||
Primitive = [ordered]@{
|
||||
Int = $len
|
||||
}
|
||||
}
|
||||
tag = [ordered]@{
|
||||
anchor = $null
|
||||
span = @{
|
||||
end = 2
|
||||
start = 0
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
$response = $json_obj | ConvertTo-Json -Depth 100 -Compress
|
||||
# Write-TraceMessage "RESULT" $($json_obj | ConvertTo-Json -Depth 100 -Compress)
|
||||
Write-Host $response
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
function end_filter {
|
||||
$response = '{"jsonrpc":"2.0","method":"response","params":{"Ok":[]}}'
|
||||
Write-Host $response
|
||||
return
|
||||
}
|
||||
|
||||
function Write-TraceMessage {
|
||||
Param
|
||||
(
|
||||
[Parameter(Mandatory = $false, Position = 0)]
|
||||
[string] $label,
|
||||
[Parameter(Mandatory = $false, Position = 1)]
|
||||
[string] $message
|
||||
)
|
||||
|
||||
[Console]::Error.WriteLine("$($label) $($message)")
|
||||
}
|
||||
|
||||
function run_loop {
|
||||
param($data)
|
||||
# param(
|
||||
# [Parameter(
|
||||
# Position = 0,
|
||||
# Mandatory = $true,
|
||||
# ValueFromPipeline = $true,
|
||||
# ValueFromPipelineByPropertyName = $true)
|
||||
# ]
|
||||
# [Alias('thedata')]
|
||||
# $data
|
||||
# )
|
||||
$prim = "Primitive"
|
||||
$method = $data | Select-Object "method"
|
||||
$params = $data.params
|
||||
$primitive = $data.params.value.$prim
|
||||
# $prim_type = ""
|
||||
# Write out some debug trace messages
|
||||
if (![String]::IsNullOrEmpty($data)) {
|
||||
Write-TraceMessage "JSON" $data
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($method)) {
|
||||
Write-TraceMessage "METHOD" $method
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($params)) {
|
||||
Write-TraceMessage "PARAMS" $params
|
||||
}
|
||||
if (![String]::IsNullOrEmpty($primitive)) {
|
||||
Write-TraceMessage "PRIMITIVE" $primitive
|
||||
# $prim_type = $primitive | Get-Member -MemberType NoteProperty | Select-Object Name
|
||||
# switch ($prim_type.Name) {
|
||||
# 'String' { $data.params.value.$prim.String }
|
||||
# 'Int' { $data.params.value.$prim.Int }
|
||||
# Default { "none-found" }
|
||||
# }
|
||||
}
|
||||
|
||||
|
||||
if ($method[0].method -eq "config") {
|
||||
# Write-TraceMessage "Received config method with: " $data
|
||||
return config
|
||||
}
|
||||
elseif ($method[0].method -eq "begin_filter") {
|
||||
return begin_filter
|
||||
}
|
||||
elseif ($method[0].method -eq "end_filter") {
|
||||
return end_filter
|
||||
}
|
||||
elseif ($method[0].method -eq "filter") {
|
||||
# return run_filter -piped $params
|
||||
return run_filter -input_data $data
|
||||
}
|
||||
}
|
||||
|
||||
function Get-PipedData {
|
||||
param(
|
||||
[Parameter(
|
||||
Position = 0,
|
||||
Mandatory = $true,
|
||||
ValueFromPipeline = $true,
|
||||
ValueFromPipelineByPropertyName = $true)
|
||||
]
|
||||
[Alias('piped')]
|
||||
[String]$piped_input
|
||||
)
|
||||
|
||||
process {
|
||||
# Write-Error $piped_input
|
||||
Write-TraceMessage "BeforeJSON" $piped_input
|
||||
$json = ConvertFrom-Json $piped_input
|
||||
run_loop -data $json
|
||||
}
|
||||
}
|
||||
|
||||
# $Input | % { Write-Host PSInput $_ }
|
||||
# $Input | ForEach-Object {
|
||||
# $json = ConvertFrom-Json $_
|
||||
# $method = $json -replace "`n", ", " | Select-Object "method"
|
||||
# $params = $json -replace "`n", ", " | Select-Object "params"
|
||||
# if ($method[0].method -eq "config") {
|
||||
# config
|
||||
# } elseif ($method[0].method -eq "begin_filter") {
|
||||
# begin_filter
|
||||
# } elseif ($method[0].method -eq "end_filter") {
|
||||
# end_filter
|
||||
# } elseif ($method[0].method -eq "filter") {
|
||||
# run_filter -params $params
|
||||
# }
|
||||
# }
|
||||
|
||||
# $prim = "Primitive"
|
||||
# $j = $json | ConvertFrom-Json
|
||||
# $j.params.value.$prim
|
||||
# String
|
||||
# ------
|
||||
# 123
|
||||
|
||||
# $Input | Get-PipedData
|
||||
$Input | ForEach-Object { $_ | Get-PipedData }
|
||||
Reference in New Issue
Block a user