DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
The Latest "Software Integration: The Intersection of APIs, Microservices, and Cloud-Based Systems" Trend Report
Get the report
  1. DZone
  2. Coding
  3. Languages
  4. Using Alfred to Quickly Open Workspaces

Using Alfred to Quickly Open Workspaces

In this case, we want to use Alfred as a way to quickly and interactively choose a VS Code workspace to open.

Nico Stewart user avatar by
Nico Stewart
·
Feb. 26, 23 · Tutorial
Like (1)
Save
Tweet
Share
1.89K Views

Join the DZone community and get the full member experience.

Join For Free

I use VSCode for almost all of my development, enabling me to save folders and their custom settings to workspace files.

Alfred is a macOS program that serves as a launcher, clipboard manager, finder, and much more. In this case, I want to use Alfred as a way to quickly and interactively choose a VSCode workspace to open.

Required Structure

Alfred’s Script Filters allow us to search a dynamic list for some item and then do something with that item. The documentation then links to the Script Filter JSON format. We’re going to create a script (binary) that outputs all discovered workspaces in the required format.

Code

We can use basic commands to discover all workspaces we want to include:

JSON
 
find ~/code -type file -maxdepth 1 -name '*.code-workspace'


This gives us all workspace files in the ~/code directory. From there, we can easily create the JSON object required by Alfred.

The equivalent command from go is:

Go
 
filepath.Glob(fmt.Sprintf("%s/*%s", filepath.Join(home, codeDir), workspaceFileType))


Where home is our home directory, and codeDir is the folder in our home directory that contains our workspaces. Now that I’ve found all our workspace files, I just need to create JSON objects from them that Alfred will consume.

We’ll define a basic struct to represent that object:

JSON
 
type alfredList struct {
    Items []alfredItem `json:"items"` // All the items to choose from
}
type alfredItem struct {
    UID          string `json:"uid"`          // ID, just the basename
    Type         string `json:"type"`         // Type of item, always 'file'
    Title        string `json:"title"`        // Title to display - friendly name
    Subtitle     string `json:"subtitle"`     // Subtitle to display - short filepath
    File         string `json:"arg"`          // Filepath to open if the item is selected
    Autocomplete string `json:"autocomplete"` // String to use for autocomplete
}


We can definitely get fancier with our objects, but for now, we’ll keep it simple. Our function will create an alfredItem given the file path to a workspace file:

JSON
 
// newAlfredItem creates an alfredItem given the path of a workspace file
func newAlfredItem(workspaceFile string) alfredItem {
    // Remove leading path and file extension
    baseName := strings.Replace(filepath.Base(workspaceFile), workspaceFileType, "", 1)

    return alfredItem{
        UID:          baseName,
        Type:         "file",
        Title:        baseName,
        Subtitle:     filepath.Join("~", codeDir, baseName), // Use '~' instead of $HOME
        File:         workspaceFile,
        Autocomplete: strings.ReplaceAll(baseName, "-", " ") // Split dash-separated words
  }
}


So we want to feed all discovered workflow files into our newAlfredItem method and then print those in the required format. With basic error handling, we end up with this:

JSON
 
matches, err := filepath.Glob(fmt.Sprintf("%s/*%s", filepath.Join(home, codeDir), workspaceFileType))
if err != nil {
  log.Fatal(err)
}

list := alfredList{}
for _, m := range matches {
  list.Items = append(list.Items, newAlfredItem(m))
}

output, err := json.Marshal(list)
if err != nil {
  log.Fatal(err)
}
fmt.Println(string(output))


Using From Alfred

Create a new blank workflow. In the new workflow, add a Script Filter by selecting Inputs -> Script Filter. We need to give it some keywords that will bring up the list when we type it. I used ‘vc’ because nothing else was using it.

To get the result of our program into the list of items, we’ll just compile our Go program and run the binary from our workflow.

Keyword vc

When we run the workflow by entering the keyword vc, we see a list of the discovered workspaces:

Results

By hitting Enter on a single workspace, we’ll open it in VS Code.

Improvements

Unless we’re adding a lot of workspaces each day, we’ll be fine getting our list from a static-ish JSON file. In the past, I’ve used Lingon to create a job that periodically rediscovers each workspace file and saves them to a JSON file.

JSON Workspace Filter (software) workflow

Published at DZone with permission of Nico Stewart. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • REST vs. Messaging for Microservices
  • Fargate vs. Lambda: The Battle of the Future
  • Full Lifecycle API Management Is Dead
  • The 5 Books You Absolutely Must Read as an Engineering Manager

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: