@naanlang/naanide

NaanIDE

NaanIDE is an Integrated Development Environment for the Naan software platform.

Release:

     Naanide for NPM version 0.9.25+1
     Copyright (c) 2024 Zulch Laboratories, Inc.

Features

• NaanIDE runs in web browsers.
• The inbuilt web server runs in NodeJS, which provides access to git and the local filesystem.
• Supported platforms are MacOS, Windows, and Linux (including Chromebook, Raspberry Pi, etc.)

Note: this is an early evaluation release.

Installation

First make sure you have installed the latest version of node.js (You may need to restart your computer after installation.)

Execute the following to install NaanIDE globally for use from the command line. For Windows, omit the sudo.

sudo npm install @naanlang/naanide -g
naanide

To update an existing installation, use update instead of install above.

Command line execution

With no argumentsnaanide starts a new local server at an available port and launches the IDE in a web page.

Command line options

naanide [options] [source file] [arguments]

--port <port>               override the IP port
-e <expression>             evaluate an expression
--version                   print NaaN version
--buildno                   print NaaN version with build number
-h, --help                  print usage information

Command line control

NaanIDE is scriptable, so the server and each browser tab can be controlled from the command line. The inbuilt workspace script opens the projects you specify in separate browser tabs in the same window, to create a workspace. The inbuilt make command builds the specified projects and stages, simplifying integration with other editors and IDEs.

naanide workspace Backend WebApp    # openthe Backend and WebApp projects
naanide make naan.dev naanide.dev   # build the dev stage of the naan and naanide projects

NaanIDE manages ports and link security automatically for simple cases, but it is fully configurable using files, environmental variables, and command line arguments. Please see the Docs tab in the IDE for advanced configuration and customization.

You can also write your own automation scripts. The following are quick "one liners", but please see the inbuilt scripts for practical examples.

# display server information:
naanide -e App.nidecon.net
{
    guid  : "55491048-1014-45f5-9af5-a2f674af8d94",
    port  : 8008,
    host  : "localhost:8008",
    oururl: "http://localhost:8008/nide.html?guid=55491048-1014-45f5-9af5-a2f674af8d94" }

# display an alert in the browser from the command line:
naanide -e 'App.nidecon.remote(App.nidecon.clients().0).1.evalq(js.w.alert("Hello, NaanIDE User!"))'

# list currently open projects in browser tabs:
naanide -e 'body (for id in App.nidecon.clients() \
    printline(App.nidecon.remote(id).1.evalq(App.model.project.active.name()).1));;'
naanide
naanlib

In Case of Difficulty

This sections lists problems you may encounter running NaanIDE, with possible solutions.

NaanIDE does not run properly, and reloading the web page doesn't help. NaanIDE saves its state across executions, and if the state is bad then it won't run properly. In browsers the restart=1 query expression will prevent using the saved state, e.g. http://localhost:8008/nide.html?restart=1. For the server, delete the .naanlang/session.state file in your home folder.

Spawned browser tabs don't run properly. This can occur when the browser's service worker gets confused and does not respond properly. With Chrome, open the chrome://serviceworker-internals/ page and click Unregister below the offending instances. Reload NaanIDE to recreate the service worker.

Next Steps

Please explore. For example, the Docs tab has reference information.
www.naanlang.org has tutorials, explanations, and how-to articles.
Please email Richard Zulch with questions and comments.