group catalog

nitc > catalog

Basic catalog generator for Nit packages

See: http://nitlanguage.org/catalog/

The tool scans packages and generates the HTML files of a catalog.

Features

  • [X] scan packages and their .ini
  • [X] generate lists of packages
  • [X] generate a page per package with the readme and most metadata
  • [ ] link/include/be included in the documentation
  • [ ] propose related packages
  • [X] show directory content (a la nitls)
  • [X] gather git information from the working directory
  • [ ] gather git information from the repository
  • [ ] gather package information from github
  • [ ] gather people information from github
  • [X] reify people
  • [X] separate information gathering from rendering
  • [ ] move up information gathering in (existing or new) service modules
  • [X] add command line options
  • [ ] harden HTML (escaping, path injection, etc)
  • [ ] nitcorn server with RESTful API

Issues and limitations

The tool works likee the other tools and expects to find valid Nit source code in the directories

  • cruft and temporary files will be collected
  • missing source file (e.g. not yet generated by nitcc) will make information incomplete (e.g. invalid module thus partial dependency and metrics)

How to use the tool as the basis of a Nit code archive on the web usable with a package manager is not clear.

All subgroups and modules

module catalog

nitc :: catalog

Basic catalog generator for Nit packages
package_diagram nitc\>catalog\> catalog md5 md5 nitc\>catalog\>->md5 counter counter nitc\>catalog\>->counter nitc\>modelize\> modelize nitc\>catalog\>->nitc\>modelize\> core core md5->core poset poset counter->poset nitc nitc nitc\>modelize\>->nitc ...core ... ...core->core ...poset ... ...poset->poset nitc\>doc\>commands\> commands nitc->nitc\>doc\>commands\> ...nitc ... ...nitc->nitc nitc\>doc\>commands\>->nitc\>catalog\> nitc\>doc\>templates\> templates nitc\>doc\>templates\>->nitc\>catalog\> nitc\>doc\>templates\>->nitc\>doc\>commands\> nitc\>doc\>api\> api nitc\>doc\>api\>->nitc\>doc\>commands\> nitc\>doc\>term\> term nitc\>doc\>term\>->nitc\>doc\>commands\> nitc... ... nitc...->nitc nitc\>doc\>api\>... ... nitc\>doc\>api\>...->nitc\>doc\>api\> nitc\>doc\>templates\>... ... nitc\>doc\>templates\>...->nitc\>doc\>templates\> nitc\>doc\>term\>... ... nitc\>doc\>term\>...->nitc\>doc\>term\>

Ancestors

group api

nitc > doc > api

Components required to build a web server about the nit model.
group base64

base64

Offers the base 64 encoding and decoding algorithms
group c

c

Structures and services for compatibility with the C language
group codecs

core > codecs

Group module for all codec-related manipulations
group collection

core > collection

This module define several collection classes.
group commands

nitc > doc > commands

group compiler

nitc > compiler

Compilation to C
group compiler_ffi

nitc > compiler > compiler_ffi

Full FFI support for the compiler
group config

config

Configuration options for nit tools and apps
group console

console

Defines some ANSI Terminal Control Escape Sequences.
group core

core

Nit common library of core classes and methods
group csv

csv

CSV document handling.
group curl

curl

Data transfer powered by the native curl library
group doc

nitc > doc

group dot

dot

Dot rendering library
group dynamic_loading_ffi

nitc > interpreter > dynamic_loading_ffi

This group implement a partial support for the Nit FFI in the interpreter.
group ffi

nitc > ffi

Full FFI support, independent of the compiler
group frontend

nitc > frontend

Collect and orchestration of main frontend phases
group gen_nit

gen_nit

Support to generate and otherwise manipulate Nit code
group github

github

Nit wrapper for Github API
group graph

graph

group html

html

HTML output facilities
group ini

ini

ini - Read and write INI configuration files
group interpreter

nitc > interpreter

Interpretation of Nit programs
group json

json

read and write JSON formatted text
group libevent

libevent

Low-level wrapper around the libevent library to manage events on file descriptors
group logger

logger

A simple logger for Nit
group markdown

markdown

A markdown parser for Nit.
group meta

meta

Simple user-defined meta-level to manipulate types of instances as object.
group metrics

nitc > metrics

Various statistics about Nit models and programs
group model

nitc > model

The meta model of Nit programs
group mongodb

mongodb

MongoDB Nit Driver.
group more_collections

more_collections

Highly specific, but useful, collections-related classes.
group neo4j

neo4j

Neo4j connector through its JSON REST API using curl.
group nitc

nitc

Nit compiler and tools
group nitcorn

nitcorn

Lightweight framework for Web applications development
group nitni

nitc > nitni

Native interface related services (used underneath the FFI)
group opts

opts

Management of options on the command line
group ordered_tree

ordered_tree

Manipulation and presentation of ordered trees.
group parser

nitc > parser

Parser and AST for the Nit language
group parser_base

parser_base

Simple base for hand-made parsers of all kinds
group perfect_hashing

perfect_hashing

Perfect hashing and perfect numbering
group performance_analysis

performance_analysis

Services to gather information on the performance of events by categories
group pipeline

pipeline

Pipelined filters and operations on iterators.
group platform

nitc > platform

Platform system, used to customize the behavior of the compiler.
group popcorn

popcorn

Popcorn
group poset

poset

Pre order sets and partial order set (ie hierarchies)
group prompt

prompt

Basic services to display a prompt
group pthreads

pthreads

POSIX Threads support
group realtime

realtime

Services to keep time of the wall clock time
group saf

nitc > saf

Nit Static Analysis Framework.
group semantize

nitc > semantize

Process bodies of methods in regard with the model.
group serialization

serialization

Abstract serialization services
group static

nitc > doc > static

Nitdoc generation framework
group template

template

Basic template system
group term

nitc > doc > term

group testing

nitc > testing

Test unit generation and execution for Nit.
group text

core > text

All the classes and methods related to the manipulation of text entities
group trees

trees

General module for tree data structures
group uml

nitc > uml

Group head module for UML generation services
group vm

nitc > vm

Entry point of all vm components

Parents

group counter

counter

Simple numerical statistical analysis and presentation
group md5

md5

Native MD5 digest implementation as Text::md5
group modelize

nitc > modelize

Create a model from nit source files

Children

Descendants

group api

nitc > doc > api

Components required to build a web server about the nit model.
group compiler

nitc > compiler

Compilation to C
group compiler_ffi

nitc > compiler > compiler_ffi

Full FFI support for the compiler
group doc

nitc > doc

group dynamic_loading_ffi

nitc > interpreter > dynamic_loading_ffi

This group implement a partial support for the Nit FFI in the interpreter.
group ffi

nitc > ffi

Full FFI support, independent of the compiler
group frontend

nitc > frontend

Collect and orchestration of main frontend phases
group interpreter

nitc > interpreter

Interpretation of Nit programs
group metrics

nitc > metrics

Various statistics about Nit models and programs
group model

nitc > model

The meta model of Nit programs
group modelize

nitc > modelize

Create a model from nit source files
group nitc

nitc

Nit compiler and tools
group nitni

nitc > nitni

Native interface related services (used underneath the FFI)
group parser

nitc > parser

Parser and AST for the Nit language
group platform

nitc > platform

Platform system, used to customize the behavior of the compiler.
group saf

nitc > saf

Nit Static Analysis Framework.
group semantize

nitc > semantize

Process bodies of methods in regard with the model.
group static

nitc > doc > static

Nitdoc generation framework
group term

nitc > doc > term

group testing

nitc > testing

Test unit generation and execution for Nit.
group uml

nitc > uml

Group head module for UML generation services
group vm

nitc > vm

Entry point of all vm components
Nit tools. Version .