Module atlas_map 

Purpose: Generate and lint ProjectAtlas structure maps from Rust.

Structs

AtlasMapConfig 🔒

Normalized atlas map configuration.

AtlasSnapshot 🔒

Snapshot written to ProjectAtlas TOON.

EffectiveConfigReport 🔒

Serializable view of the effective ProjectAtlas configuration.

GitignoreInitReport 🔒

Result of creating a project-root .gitignore when it is missing.

IgnoreListReport 🔒

Current ProjectAtlas ignore configuration report.

IgnoreMutationReport 🔒

Result of adding or removing a manual ProjectAtlas ignore entry.

ImportedPurposeRecord 🔒

Purpose record imported from legacy ProjectAtlas metadata.

LintOptions 🔒

Lint options supplied by the CLI.

MapRecord 🔒

ProjectAtlas map record.

NonsourceEntries 🔒

Parsed non-source entry set and validation state.

RawConfig 🔒

Raw deserialized config file.

RawProject 🔒

Raw project table.

RawPurpose 🔒

Raw purpose table.

RawScan 🔒

Raw scan table.

RawSummaryRules 🔒

Raw summary-rules table.

RawUntracked 🔒

Raw untracked table.

RepoPaths 🔒

Result of collecting repository paths.

Enums

AtlasMapError 🔒

Atlas map operation errors.

IgnoreEntryKind 🔒

Manual ProjectAtlas ignore entry kind.

Constants

DEFAULT_ASSET_EXTENSIONS 🔒

Asset extensions recognized for untracked-file reporting.

DEFAULT_EXCLUDE_DIR_NAMES 🔒

Directory names excluded from scans by default.

DEFAULT_LEGACY_PURPOSE_FILENAME 🔒

Legacy folder-purpose filename accepted only as migration input.

DEFAULT_LINE_COMMENT_PREFIXES 🔒

Line comment prefixes supported by default.

DEFAULT_MAP_PATH 🔒

Default generated map path.

DEFAULT_MAX_SCAN_LINES 🔒

Default maximum number of lines scanned for purpose headers.

DEFAULT_NONSOURCE_PATH 🔒

Default non-source summary input path.

DEFAULT_SOURCE_EXTENSIONS 🔒

Source extensions scanned for Purpose metadata by default.

DEFAULT_SUMMARY_MAX_LENGTH 🔒

Default maximum purpose summary length.

DEFAULT_TEXT_INDEX_MAX_BYTES 🔒

Default maximum UTF-8 file size persisted into SQLite text search.

DURABLE_PROJECTATLAS_INPUT_PATHS 🔒

Durable .projectatlas inputs indexed by SQLite but ignored by legacy map/lint.

OVERVIEW_KEYS 🔒

Ordered overview keys written into the TOON map.

REQUIRED_EXCLUDE_DIR_NAMES 🔒

Directory names excluded from scans even when config is hand-edited.

Functions

absolutize 🔒

Convert a possibly relative path to an absolute path.

add_ignore_entry 🔒

Add one manual ProjectAtlas ignore entry to config.

append_existing_map_purpose_records_with_reader 🔒

Append approved map rows using the caller-owned text reader.

append_imported_records 🔒

Append valid imported records from map records.

append_invalid_map 🔒

Append invalid path issue map.

append_list 🔒

Append TOON list rows.

append_nonsource_errors 🔒

Append non-source validation errors.

append_record_rows 🔒

Append TOON record rows.

append_untracked_report 🔒

Append untracked-file report and optional errors.

build_file_records 🔒

Build file records and validation lists.

build_file_records_with_reader 🔒

Build file purpose rows through a caller-owned bounded text reader.

build_folder_records 🔒

Build folder records and validation lists.

build_folder_records_with_reader 🔒

Build folder purpose rows through a caller-owned bounded text reader.

build_folder_tree 🔒

Build folder tree lines.

build_snapshot 🔒

Build the full atlas snapshot.

build_summary_duplicates 🔒

Build duplicate summary entries.

collect_python_docstring 🔒

Collect a Python docstring body.

collect_repo_paths 🔒

Collect repository folders, source files, and non-source files.

collect_until 🔒

Collect lines until a marker appears.

compute_file_hash 🔒

Compute file record hash.

compute_folder_hash 🔒

Compute folder path hash.

compute_overview 🔒

Compute overview counters.

config_path_is_projectatlas 🔒

Return whether the config path is inside .projectatlas.

configured_nonsource_registry_path 🔒

Return the configured non-source registry as a repository-relative path.

default_config_root_value 🔒

Return the [project].root value that keeps an explicit init config bound to root.

default_config_text 🔒

Build default config text.

default_config_text_for 🔒

Build default config text for a config file created by init.

default_config_text_with_root 🔒

Build default config text with the supplied project root value.

default_gitignore_text 🔒

Default .gitignore text created only by the explicit setup helper.

effective_config_path_display 🔒

Render native paths unchanged on hosts without Windows extended prefixes.

effective_config_report 🔒

Build the effective configuration report used by agents and docs.

exclude_dir_name_set 🔒

Normalize excluded directory names and preserve required internal excludes.

existing_asset_roots 🔒

List existing asset roots.

extract_block_comment_purpose 🔒

Extract a purpose from a generic block comment.

extract_javadoc_purpose 🔒

Extract a purpose from a Javadoc-style block.

extract_line_comment_purpose 🔒

Extract a purpose from a line-comment header.

extract_purpose_header_with_reader 🔒

Extract a purpose header through a caller-owned bounded text reader.

extract_python_docstring_purpose 🔒

Extract a purpose from a Python module docstring.

extract_vue_purpose 🔒

Extract a purpose from a Vue script or style block.

find_config_path 🔒

Find a default config path under the current root.

first_content_line 🔒

Return the first content line after shebangs and blanks.

first_python_doc_line 🔒

Return the first Python docstring candidate line.

format_list 🔒

Format report list items.

format_overview 🔒

Format overview counters.

generated_at 🔒

Return a simple UTC-ish generated timestamp.

has_excluded_suffix_component 🔒

Return whether any path component has an excluded suffix.

hash_text 🔒

Hash a text payload with BLAKE3.

ignore_list_report 🔒

Build a report for current ignore settings.

ignore_mutation_report 🔒

Build a report for an ignore mutation.

imported_purpose_records_from_nodes 🔒

Extract approved legacy purpose records from an existing controlled scan.

imported_purpose_records_from_paths 🔒

Extract approved purpose rows from one already-selected path inventory.

init_gitignore 🔒

Create a project-root .gitignore when it is missing.

init_project_with_config 🔒

Write default ProjectAtlas config files, honoring an explicitly selected config path.

invalid_record 🔒

Create an invalid placeholder record.

is_allowed_untracked 🔒

Return whether an untracked path is allowed.

is_asset_file 🔒

Return whether a file is an asset by extension.

is_durable_projectatlas_input 🔒

Return whether a file is a durable ProjectAtlas input outside legacy map/lint.

is_legacy_map_metadata_folder 🔒

Return whether a folder is ProjectAtlas metadata ignored by legacy map/lint.

is_path_special_source_family 🔒

Return whether the scanner detected a source-like file family without relying on extension policy.

is_php_open_tag_line 🔒

Return whether a line is only a PHP open tag or declaration before comments.

is_source_node 🔒

Return whether a scanned file should be treated as source.

is_under_any_prefix 🔒

Return whether a path is below any configured prefix.

join_report 🔒

Join report sections with newlines.

lint_map 🔒

Lint the atlas map and return a report plus exit code.

list_ignore_entries 🔒

List effective ProjectAtlas ignore policy.

load_atlas_config 🔒

Load atlas map configuration from disk.

load_atlas_config_for_root 🔒

Load atlas map configuration for an explicit project root.

load_atlas_config_from_text 🔒

Parse an already-bounded configuration input using normal path semantics.

load_config_document_for_edit 🔒

Load an editable TOML document, creating default config text when absent.

load_db_purpose_records 🔒

Load approved purpose records from the durable SQLite index.

merge_records 🔒

Merge source and non-source records.

missing_record 🔒

Create a missing placeholder record.

needs_quoted_cell 🔒

Return whether a tabular TOON cell needs quotes.

normalize_config 🔒

Normalize raw config into runtime config.

normalize_ignore_dir_name 🔒

Normalize one directory-name ignore entry.

normalize_ignore_value 🔒

Normalize one manual ignore entry.

normalize_language_overrides 🔒

Validate explicit exact-filename and extension language selections.

normalize_prefix_set 🔒

Normalize path-prefix strings into slash-separated values.

normalize_repo_string 🔒

Normalize a path-like string to repository slash format.

normalize_set 🔒

Normalize extension strings into a lower-case set.

normalize_style_map 🔒

Normalize per-extension purpose styles.

normalize_summary 🔒

Normalize a summary to a single-line value.

normalized_extension 🔒

Return a normalized extension from a repository path.

project_root_for_projectatlas_config 🔒

Return the project root implied by .projectatlas/config.toml.

purpose_from_lines 🔒

Extract a normalized purpose from comment lines.

push_escaped_char 🔒

Push one escaped character from a quoted TOON cell.

push_unicode_escape 🔒

Push a four-digit Unicode escape when present.

push_unicode_escape_digits 🔒

Push a four-digit Unicode escape into a quoted string.

quote_toon_string 🔒

Quote a string with JSON-compatible escapes for TOON scalar cells.

read_folder_purpose_with_reader 🔒

Read folder purpose metadata through a caller-owned bounded text reader.

read_generated_at 🔒

Parse the generated timestamp from TOON.

read_hashes 🔒

Parse file and folder hashes from TOON.

read_nonsource_file_entries 🔒

Read non-source file entries.

read_nonsource_file_entries_with_reader 🔒

Read non-source purpose rows through a caller-owned bounded text reader.

read_text_file 🔒

Read one complete UTF-8 atlas-map input through the compatibility path.

record_json 🔒

Convert a map record to JSON.

remove_ignore_entry 🔒

Remove one manual ProjectAtlas ignore entry from config.

render_toon 🔒

Render a TOON snapshot.

repo_join 🔒

Join a repository-relative slash path onto a root.

repo_paths_from_nodes 🔒

Classify one existing scan into legacy map input paths.

resolve_config_edit_path 🔒

Resolve the config file path that ignore commands should edit.

resolve_purpose_style 🔒

Resolve configured purpose style for a relative path.

skip_yaml_frontmatter 🔒

Return lines after a leading YAML frontmatter block when one is present.

split_record_cells 🔒

Split a compact TOON record row into cells.

stable_generated_at 🔒

Preserve an existing timestamp when map contents are unchanged.

string_array_values 🔒

Read a string array from the [scan] table, returning an empty set when absent.

string_set 🔒

Convert optional strings into a set with defaults.

strip_line_comment_prefix 🔒

Strip a line-comment prefix.

summarize_extensions 🔒

Summarize extensions for reporting.

toml_array 🔒

Render string values as a TOML array.

toon_cell 🔒

Render a TOON scalar cell with JSON-compatible escaping when needed.

validate_summary 🔒

Validate a purpose summary.

write_config_document 🔒

Persist an editable TOML document to disk.

write_json_map 🔒

Write JSON map next to TOON map.

write_map 🔒

Generate and write the atlas map.

write_string_array 🔒

Replace one [scan] string array while preserving unrelated config content.

write_toon 🔒

Write TOON map to disk.

Type Aliases

AtlasMapResult 🔒

Result alias for atlas map operations.