periplus-map 0.2.1__tar.gz → 0.4.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {periplus_map-0.2.1 → periplus_map-0.4.0}/PKG-INFO +94 -29
- {periplus_map-0.2.1 → periplus_map-0.4.0}/README.md +92 -28
- {periplus_map-0.2.1 → periplus_map-0.4.0}/pyproject.toml +3 -2
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/checkmap.py +4 -6
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/cli.py +146 -77
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/emit.py +32 -13
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/rules.py +1 -8
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/tree.py +4 -3
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/errors.py +14 -9
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/map.py +24 -28
- periplus_map-0.4.0/src/periplus/mapshared.py +23 -0
- periplus_map-0.4.0/src/periplus/navigate/export.py +162 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/find.py +25 -23
- periplus_map-0.4.0/src/periplus/navigate/listing.py +75 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/mapfile.py +34 -24
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/path.py +35 -37
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/show.py +82 -42
- periplus_map-0.4.0/src/periplus/navigate/slice.py +112 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/types.py +51 -21
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/walk.py +55 -31
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/call/call.yaml +13 -25
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_theme_include.yaml +8 -2
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/menu_link/menu_link.yaml +4 -2
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/pack.yaml +3 -2
- periplus_map-0.4.0/src/periplus/packs/drupal_basic@0.3.0/route/route_call.yaml +72 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/edges/edge_kinds.yaml +2 -1
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/edges/find_structure.yaml +3 -2
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/types/find_declarations.yaml +3 -2
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/types/node_types.yaml +1 -0
- periplus_map-0.4.0/src/periplus/skills/periplus-gaps/SKILL.md +57 -0
- periplus_map-0.4.0/src/periplus/skills/periplus-map/SKILL.md +74 -0
- periplus_map-0.4.0/src/periplus/skills/periplus-map/references/descriptions.schema.json +43 -0
- periplus_map-0.4.0/src/periplus/skills/periplus-rutter/SKILL.md +208 -0
- periplus_map-0.4.0/src/periplus/skills_install.py +54 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/spec.py +3 -21
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/update.py +26 -14
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/validate.py +3 -18
- periplus_map-0.2.1/src/periplus/navigate/listing.py +0 -42
- {periplus_map-0.2.1 → periplus_map-0.4.0}/.gitignore +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/LICENSE +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/NOTICE +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/schema/map.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/schema/navigation.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/schema/pack-file.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/schema/pack-manifest.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/schema/project-settings.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/spec/engine.md +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/contract/spec/rules.md +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/detect.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/check.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/packload.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/pattern.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/select.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/engine/source.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/init.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/layout.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/manifest.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/navigate/ids.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/advancedqueue_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/ai_basic@0.0.1/ai_agent/ai_agent.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/ai_basic@0.0.1/ai_agent/ai_agent_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/ai_basic@0.0.1/ai_function_call/ai_function_call.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/ai_basic@0.0.1/ai_function_call/ai_function_call_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/ai_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/config_pages_basic@0.0.1/bundle/config_pages_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/config_pages_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/crop_basic@0.0.1/bundle/crop_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/crop_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_placement.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_placement_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_altered.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_content.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_derived.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_deriver.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_type_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/block/block_type_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/cache/cache.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/cache/cache_backend.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/component/sdc.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/component/sdc_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/component/sdc_use.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/config/config_object.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/display/display.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/display/display_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/display/display_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/entity/entity.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/entity/entity_class.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/entity/entity_save.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/entity/entity_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/entity/entity_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/field/field_instance_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/field/field_storage.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/field/field_storage_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/form/form.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/form/form_class.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/form/form_id.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/form/form_methods.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/hook/hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/module/module.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/module/module_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/plugin/plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/plugin/plugin_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/recommendations/recommendations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/service/service.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/service/service_autowire.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/service/service_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal@0.1.0/service/service_use.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/action/action.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/action/action_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/action/action_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block_type/block_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/block_type/block_type_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/boundary/boundary_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/component/component.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/config/config_object.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/display/display.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/display/display_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/display/display_mode_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/config_entity_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/config_entity_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/content_entity_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/content_entity_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/entity_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_type/field_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_type/field_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_widget/field_widget_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/field_widget/field_widget_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/form/form_id.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/library/library.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/library/library_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/local_action/local_action.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/local_action/local_action_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/mail/mail.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/mail/mail_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/menu_link/menu_link_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/module/module.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/module/module_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/permission/permission.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/permission/permission_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/role/role.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/role/role_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/route/route.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_options.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_requirements.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/service/service.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/service/service_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/template/template.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/template/template_route_link.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/theme/theme.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/theme/theme_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/template_suggestion.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/theme_hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/theme_hook_render.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/url/url.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_field_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_filter_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_style_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_php.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_php_array.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_twig.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/php_function_holder.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/behavior/behavior.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting_in_js.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting_in_php.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drush_basic@0.0.1/command/command.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drush_basic@0.0.1/command/command_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drush_basic@0.0.1/command/command_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/drush_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/eck_basic@0.0.1/bundle/eck_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/eck_basic@0.0.1/entity_type/eck_entity_type_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/eck_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go@0.0.2/interfaces/satisfies.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go@0.0.2/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go@0.0.2/types/find_declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go@0.0.2/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go_basic@0.0.3/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go_basic@0.0.3/rules/calls.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go_basic@0.0.3/rules/declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go_basic@0.0.3/rules/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/go_basic@0.0.3/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/js_basic@0.0.1/function/function.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/rules/classes.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/rules/config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/rules/routes.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/rules/types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/laravel_basic@0.0.5/rules/views.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/paragraphs_basic@0.0.1/bundle/paragraph_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/paragraphs_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/edges/edge_kinds.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/edges/find_calls.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/edges/find_imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/edges/find_member_access.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/edges/find_structure.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/embedded/embedded_regions.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/imports/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/resolution/excluded_tokens.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/resolution/resolution.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/types/find_declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php@0.1.0/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/imports/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/php_basic@0.2.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/profile_basic@0.0.1/bundle/profile_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/profile_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/event/salesforce_event.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping/salesforce_mapping.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping/salesforce_mapping_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping_field/salesforce_mapping_field.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping_field/salesforce_mapping_field_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig@0.0.1/types/template.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_tweak_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/block.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/entity.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/field.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/menu.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/webform_basic@0.0.1/bundle/webform_submission_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/webform_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/yaml@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/yaml@0.0.1/types/find_mapping_entry.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/yaml@0.0.1/types/yaml_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs/yaml_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/packs.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/preflight.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/py.typed +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/report.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/resolution.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/settings.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.4.0}/src/periplus/settings.stub.yml +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: periplus-map
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.4.0
|
|
4
4
|
Summary: A schema-first, deterministic codebase mapper, configurable to any stack.
|
|
5
5
|
Project-URL: Homepage, https://github.com/camoa/periplus
|
|
6
6
|
Project-URL: Repository, https://github.com/camoa/periplus
|
|
@@ -28,6 +28,7 @@ Requires-Dist: tree-sitter-php==0.24.1
|
|
|
28
28
|
Requires-Dist: tree-sitter==0.26.0
|
|
29
29
|
Provides-Extra: dev
|
|
30
30
|
Requires-Dist: mypy==2.3.1; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest-xdist==3.8.0; extra == 'dev'
|
|
31
32
|
Requires-Dist: pytest==9.1.1; extra == 'dev'
|
|
32
33
|
Requires-Dist: ruff==0.15.0; extra == 'dev'
|
|
33
34
|
Requires-Dist: types-jsonschema==4.26.0.20260518; extra == 'dev'
|
|
@@ -47,11 +48,11 @@ Description-Content-Type: text/markdown
|
|
|
47
48
|
[](LICENSE)
|
|
48
49
|
[](https://github.com/camoa/periplus/tags)
|
|
49
50
|
[](pyproject.toml)
|
|
50
|
-
<sub>The CI workflow, `.github/workflows/checks.yml`, installs the package with its `dev
|
|
51
|
-
and `
|
|
52
|
-
every bundled pack. It does not run the
|
|
51
|
+
<sub>The CI workflow, `.github/workflows/checks.yml`, installs the package with its `dev`,
|
|
52
|
+
`js` and `go` extras for the tests. It runs pytest on Python 3.11 to 3.14, ruff and mypy, and validates
|
|
53
|
+
every bundled pack. It does not run the acceptance scripts, and it never maps a Go project.</sub>
|
|
53
54
|
|
|
54
|
-
Status: **beta**, version 0.
|
|
55
|
+
Status: **beta**, version 0.4.0.
|
|
55
56
|
|
|
56
57
|
</div>
|
|
57
58
|
|
|
@@ -104,7 +105,7 @@ periplus --version
|
|
|
104
105
|
To install a tagged version from the repository:
|
|
105
106
|
|
|
106
107
|
```
|
|
107
|
-
uv tool install git+https://github.com/camoa/periplus@v0.
|
|
108
|
+
uv tool install git+https://github.com/camoa/periplus@v0.4.0
|
|
108
109
|
```
|
|
109
110
|
|
|
110
111
|
To install from a local copy of this repository:
|
|
@@ -113,6 +114,37 @@ To install from a local copy of this repository:
|
|
|
113
114
|
uv tool install /path/to/periplus # or: pip install /path/to/periplus
|
|
114
115
|
```
|
|
115
116
|
|
|
117
|
+
After any of these installs, run `periplus skills install` to copy the Claude skills Periplus
|
|
118
|
+
ships into `~/.claude/skills`. Run it again after an update to replace the older copies.
|
|
119
|
+
|
|
120
|
+
#### Use the skills with other agents
|
|
121
|
+
|
|
122
|
+
The skills follow the [Agent Skills](https://agentskills.io) format: a folder with a `SKILL.md`
|
|
123
|
+
file. After `periplus skills install`, the folders `periplus-gaps`, `periplus-map` and
|
|
124
|
+
`periplus-rutter` are in `~/.claude/skills`. Copy them to the folder the agent reads, and copy them
|
|
125
|
+
again after each update. The folder `~/.agents/skills` serves four agents at once:
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
mkdir -p ~/.agents/skills && rsync -a --delete ~/.claude/skills/periplus-* ~/.agents/skills/
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
- [Codex CLI](https://learn.chatgpt.com/docs/build-skills): `~/.agents/skills`, or `.agents/skills` in a repository.
|
|
132
|
+
- [Gemini CLI](https://geminicli.com/docs/cli/skills/): `~/.gemini/skills` or `~/.agents/skills`, or `.gemini/skills` or `.agents/skills` in a workspace.
|
|
133
|
+
- [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills): `~/.copilot/skills`, `~/.agents/skills` or `~/.claude/skills`, so the Claude install already works. A repository can use `.github/skills`.
|
|
134
|
+
- [Cursor](https://cursor.com/docs/context/skills): `~/.cursor/skills` or `~/.agents/skills`, and it also reads `~/.claude/skills`. A repository can use `.cursor/skills`.
|
|
135
|
+
|
|
136
|
+
To upgrade an install from PyPI, use the tool you installed with:
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
uv tool upgrade periplus-map # keeps the extras you installed
|
|
140
|
+
pipx upgrade periplus-map
|
|
141
|
+
pip install -U 'periplus-map[go,js]' # pip needs the extras named again
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Then run `periplus skills install` again, and repeat the copy above for any other agent. Read the
|
|
145
|
+
[changelog](CHANGELOG.md) before you upgrade: when a bundled rutter's version changes, update the
|
|
146
|
+
pins in your project's settings with `periplus update` and map again.
|
|
147
|
+
|
|
116
148
|
To update a local install, pull the repository and run `uv tool install /path/to/periplus` again. A
|
|
117
149
|
local directory is rebuilt when `pyproject.toml` changes or a file under `src/periplus` does. Run
|
|
118
150
|
`uv tool install --reinstall /path/to/periplus` for the form that always rebuilds. The command
|
|
@@ -213,9 +245,9 @@ An unresolved node from a map of a Drupal site, shortened:
|
|
|
213
245
|
|
|
214
246
|
Each edge has `from`, `to`, `kind`, its locations, an `occurrences` count and its provenance.
|
|
215
247
|
|
|
216
|
-
**Determinism.**
|
|
217
|
-
|
|
218
|
-
|
|
248
|
+
**Determinism.** `tests/test_demo_b_map_determinism.py` maps one project in separate processes
|
|
249
|
+
under different hash seeds and locales, and the maps are byte-identical. This ran on one Linux
|
|
250
|
+
machine. The design aims for identical maps across machines, but no test has
|
|
219
251
|
compared two machines or two operating systems yet.
|
|
220
252
|
|
|
221
253
|
### The rutters provided
|
|
@@ -223,14 +255,16 @@ compared two machines or two operating systems yet.
|
|
|
223
255
|
What the map holds depends on the rutters loaded. Bundled rutters load by name. Example rutters
|
|
224
256
|
are copied into a project's `.periplus/packs`. The tables group them by language and by framework.
|
|
225
257
|
|
|
258
|
+
[`docs/rutters.md`](docs/rutters.md) lists every bundled rutter with its dependencies.
|
|
259
|
+
|
|
226
260
|
<details>
|
|
227
261
|
<summary><strong>Languages and file types</strong></summary>
|
|
228
262
|
|
|
229
263
|
| Rutter | Version | What it finds |
|
|
230
264
|
|---|---|---|
|
|
231
|
-
| `php_basic` | 0.2.0 | PHP classes, interfaces, traits, enums, functions and methods. Inheritance, interfaces, traits, containment, and
|
|
232
|
-
| `js_basic` | 0.0.1 | JavaScript functions that have a name of their own, each under its script's path. Reads a parse tree. Needs the `js` extra. |
|
|
233
|
-
| `go_basic` | 0.0.3 | Go functions, methods, structs and interfaces, each under its package's import path. Calls written `f(x)` inside one package, and `pkg.F(x)` through an import, to another package of the module or to an unresolved function outside it. Reads a parse tree. Needs the `go` extra. |
|
|
265
|
+
| `php_basic` | 0.2.0 | PHP classes, interfaces, traits, enums, functions and methods. Inheritance, interfaces, traits, containment, properties and parameters with their types, and call sites. Plain and static calls, and method calls through a typed or assigned property; a call to a PHP builtin function makes nothing. Reads a parse tree. |
|
|
266
|
+
| `js_basic` | 0.0.1 | JavaScript scripts, and the functions that have a name of their own, each under its script's path. It reads `.js` files only and maps no calls. Reads a parse tree. Needs the `js` extra. |
|
|
267
|
+
| `go_basic` | 0.0.3 | Go functions, methods, structs and interfaces, each under its package's import path. Calls written `f(x)` inside one package, and `pkg.F(x)` through an import, to another package of the module or to an unresolved function outside it. It skips test files and `vendor`, and needs the module path in the settings as `values.module`. Reads a parse tree. Needs the `go` extra. |
|
|
234
268
|
| `yaml_basic` | 0.1.0 | Claims `.yml` and `.yaml` files for rutters that depend on it. No rules of its own. |
|
|
235
269
|
| `twig_basic` | 0.1.0 | Claims `.twig` files for rutters that depend on it. No rules of its own. |
|
|
236
270
|
|
|
@@ -256,7 +290,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
256
290
|
| `profile_basic` | 0.0.1 | Each Profile type, from its config file, as a bundle of the entity type `profile`. |
|
|
257
291
|
| `salesforce_basic` | 0.0.1 | Salesforce mapping field plugins; each mapping with its Salesforce object and its edges to the bundle, entity type and fields it maps; the Salesforce events that subscribers name. |
|
|
258
292
|
| `twig_tweak_basic` | 0.0.1 | The block plugins, menus, entity types and field storages that Twig Tweak functions such as `drupal_block('x')` name in templates. |
|
|
259
|
-
| `webform_basic` | 0.0.1 | Webform handler plugins, by annotation, and each webform, from its config file, as a bundle of `webform_submission`. |
|
|
293
|
+
| `webform_basic` | 0.0.1 | Webform handler plugins, by annotation, each joined to its class, and each webform, from its config file, as a bundle of `webform_submission`. |
|
|
260
294
|
|
|
261
295
|
</details>
|
|
262
296
|
|
|
@@ -265,7 +299,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
265
299
|
|
|
266
300
|
| Rutter | Version | What it finds |
|
|
267
301
|
|---|---|---|
|
|
268
|
-
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups,
|
|
302
|
+
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups, each joined to its controller method, its resource controller or the view it renders, controllers, models, migrations, Blade views with their includes, extends and component tags, and configuration files with the text keys of the array each returns. The views and keys that `view('x')` and `config('x.y')` calls name in PHP functions and methods. Depends on `php_basic`. Reads text, and a parse tree for the calls. |
|
|
269
303
|
|
|
270
304
|
</details>
|
|
271
305
|
|
|
@@ -316,15 +350,10 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
316
350
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
317
351
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
318
352
|
|
|
319
|
-
New in this release: `
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
`tables`, a call argument written as a class constant read through the grammar's
|
|
324
|
-
`constant_access` and `constant_declaration` keys, and a rule narrowed to one file ending by
|
|
325
|
-
`match.ending`. A rutter's `boundary` lists the framework classes the map never reads. Each one
|
|
326
|
-
an edge reaches becomes a `declared` node, and a class that descends from one may take the type
|
|
327
|
-
the list gives it. Settings `values` pass project facts, such as a Go module path, to a rutter.
|
|
353
|
+
New in this release: `periplus slice` cuts a map down to the neighbourhood of a node and
|
|
354
|
+
`periplus export` writes a map or slice as GraphML, Mermaid or DOT; `slice --direction both`
|
|
355
|
+
follows edges either way and GraphML labels name each node; and the Drupal rutter maps a route
|
|
356
|
+
name written in a PHP call to its route.
|
|
328
357
|
|
|
329
358
|
## Write a rutter
|
|
330
359
|
|
|
@@ -490,6 +519,38 @@ map holds and nothing more. `periplus check-map` runs the full schema check that
|
|
|
490
519
|
skip. The [navigation guide](docs/navigation.md) gives each command's options, output and exit
|
|
491
520
|
codes, with an example you can run.
|
|
492
521
|
|
|
522
|
+
### Slice and export
|
|
523
|
+
|
|
524
|
+
`periplus slice` writes a piece of the map to a map file of its own. `periplus export` prints the
|
|
525
|
+
whole map as GraphML, DOT or Mermaid. To draw a part of the map, slice it, then export the slice.
|
|
526
|
+
|
|
527
|
+
```
|
|
528
|
+
periplus slice [ID ...] [--path PREFIX] --out FILE [--direction out|in|both] [--depth N] [--kind K] [--limit N] [--map PATH]
|
|
529
|
+
periplus export --format graphml|dot|mermaid [--map PATH]
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
`slice` starts from the ids you name and from every node whose first file starts with `--path PREFIX`, and follows edges
|
|
533
|
+
from them. `--direction out` and `in` follow edges one way; `both` follows an edge either way at every hop (default `both`).
|
|
534
|
+
`--depth N` sets how many edges to follow (default 1), and `--kind K` keeps only edges of kind `K`;
|
|
535
|
+
repeat it for several. `--limit N` stops the slice when it would hold more than `N` items (default
|
|
536
|
+
500, `0` for no limit): the command exits 32 and writes nothing. An unknown id, or a prefix that
|
|
537
|
+
matches nothing, exits 31. `--out` is required, and a slice is a smaller map, so name it so it
|
|
538
|
+
cannot replace the full map.
|
|
539
|
+
|
|
540
|
+
`export` prints to standard output and its warnings to standard error. GraphML names each node by a generated token and carries the map id as its label, with the
|
|
541
|
+
node type and state, the edge kind, and the file and line where there is one. DOT and Mermaid
|
|
542
|
+
label each node with its id and type.
|
|
543
|
+
|
|
544
|
+
```
|
|
545
|
+
periplus slice --path src/Billing/ --out billing.map.json
|
|
546
|
+
periplus export --format graphml --map billing.map.json > billing.graphml # open in Gephi Lite
|
|
547
|
+
periplus export --format dot --map billing.map.json > billing.dot # render with Graphviz
|
|
548
|
+
periplus export --format mermaid --map billing.map.json > billing.mmd # wrap in a mermaid code fence in a pull request
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
Gephi Lite handles light graphs; use Gephi for more than about 10,000 nodes. Mermaid on GitHub may
|
|
552
|
+
not draw a graph above 500 edges or 50,000 characters, and the export warns when it passes either.
|
|
553
|
+
|
|
493
554
|
## CLI reference
|
|
494
555
|
|
|
495
556
|
Run each command in the project folder.
|
|
@@ -508,11 +569,14 @@ periplus show ID # show one node and the edges at it
|
|
|
508
569
|
periplus neighbors ID # list the items an item's edges lead to
|
|
509
570
|
periplus affected ID # list the items whose edges lead to an item
|
|
510
571
|
periplus path FROM TO # show every shortest chain of edges from one item to another
|
|
572
|
+
periplus slice ID --out FILE # write the items around some items or a path to a smaller map
|
|
573
|
+
periplus export --format F # print the map as graphml, dot or mermaid
|
|
574
|
+
periplus skills install # copy the Claude skills Periplus ships into ~/.claude/skills
|
|
511
575
|
```
|
|
512
576
|
|
|
513
577
|
`periplus validate` takes a bare `name`, or `name@version` to pick one of several copies.
|
|
514
|
-
`periplus update` leaves project-local and unknown pins as they are. Every command but `init`
|
|
515
|
-
takes `--format json`. The
|
|
578
|
+
`periplus update` leaves project-local and unknown pins as they are. Every command but `init`, `slice`
|
|
579
|
+
and `export` takes `--format json`. The nine commands that read a map take `--map PATH`; the
|
|
516
580
|
[navigation guide](docs/navigation.md) gives their other options. `periplus --version` prints the
|
|
517
581
|
installed version, and `periplus <command> --help` gives each command's options.
|
|
518
582
|
|
|
@@ -533,9 +597,11 @@ installed version, and `periplus <command> --help` gives each command's options.
|
|
|
533
597
|
|
|
534
598
|
## Tests and checks
|
|
535
599
|
|
|
536
|
-
The pytest suite
|
|
537
|
-
`scripts/demo.d` and stops at the first failure
|
|
538
|
-
|
|
600
|
+
The pytest suite tests the engine and the bundled rutters. `scripts/demo.sh` runs the acceptance
|
|
601
|
+
scripts in `scripts/demo.d` and stops at the first failure: one for each command, one for each
|
|
602
|
+
bundled stack family, and the README and guide examples. Each script maps a small project and
|
|
603
|
+
compares the result with what it expects. A person runs them at the end of a task. The CI workflow
|
|
604
|
+
behind the checks badge does not run them.
|
|
539
605
|
|
|
540
606
|
To propose a change, read [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
|
541
607
|
|
|
@@ -557,7 +623,6 @@ lists the rest, each rutter's among them.
|
|
|
557
623
|
- **An unresolved end takes its first candidate type.** For example, `pathlib.Path` becomes a
|
|
558
624
|
`python.function`. The map states a type it cannot know.
|
|
559
625
|
- **One JSON file, and every run is a full run.** There is no split map and no incremental run.
|
|
560
|
-
- **No export.** There is no GraphML, Mermaid or DOT output yet.
|
|
561
626
|
|
|
562
627
|
## License
|
|
563
628
|
|
|
@@ -8,11 +8,11 @@
|
|
|
8
8
|
[](LICENSE)
|
|
9
9
|
[](https://github.com/camoa/periplus/tags)
|
|
10
10
|
[](pyproject.toml)
|
|
11
|
-
<sub>The CI workflow, `.github/workflows/checks.yml`, installs the package with its `dev
|
|
12
|
-
and `
|
|
13
|
-
every bundled pack. It does not run the
|
|
11
|
+
<sub>The CI workflow, `.github/workflows/checks.yml`, installs the package with its `dev`,
|
|
12
|
+
`js` and `go` extras for the tests. It runs pytest on Python 3.11 to 3.14, ruff and mypy, and validates
|
|
13
|
+
every bundled pack. It does not run the acceptance scripts, and it never maps a Go project.</sub>
|
|
14
14
|
|
|
15
|
-
Status: **beta**, version 0.
|
|
15
|
+
Status: **beta**, version 0.4.0.
|
|
16
16
|
|
|
17
17
|
</div>
|
|
18
18
|
|
|
@@ -65,7 +65,7 @@ periplus --version
|
|
|
65
65
|
To install a tagged version from the repository:
|
|
66
66
|
|
|
67
67
|
```
|
|
68
|
-
uv tool install git+https://github.com/camoa/periplus@v0.
|
|
68
|
+
uv tool install git+https://github.com/camoa/periplus@v0.4.0
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
To install from a local copy of this repository:
|
|
@@ -74,6 +74,37 @@ To install from a local copy of this repository:
|
|
|
74
74
|
uv tool install /path/to/periplus # or: pip install /path/to/periplus
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
+
After any of these installs, run `periplus skills install` to copy the Claude skills Periplus
|
|
78
|
+
ships into `~/.claude/skills`. Run it again after an update to replace the older copies.
|
|
79
|
+
|
|
80
|
+
#### Use the skills with other agents
|
|
81
|
+
|
|
82
|
+
The skills follow the [Agent Skills](https://agentskills.io) format: a folder with a `SKILL.md`
|
|
83
|
+
file. After `periplus skills install`, the folders `periplus-gaps`, `periplus-map` and
|
|
84
|
+
`periplus-rutter` are in `~/.claude/skills`. Copy them to the folder the agent reads, and copy them
|
|
85
|
+
again after each update. The folder `~/.agents/skills` serves four agents at once:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
mkdir -p ~/.agents/skills && rsync -a --delete ~/.claude/skills/periplus-* ~/.agents/skills/
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
- [Codex CLI](https://learn.chatgpt.com/docs/build-skills): `~/.agents/skills`, or `.agents/skills` in a repository.
|
|
92
|
+
- [Gemini CLI](https://geminicli.com/docs/cli/skills/): `~/.gemini/skills` or `~/.agents/skills`, or `.gemini/skills` or `.agents/skills` in a workspace.
|
|
93
|
+
- [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills): `~/.copilot/skills`, `~/.agents/skills` or `~/.claude/skills`, so the Claude install already works. A repository can use `.github/skills`.
|
|
94
|
+
- [Cursor](https://cursor.com/docs/context/skills): `~/.cursor/skills` or `~/.agents/skills`, and it also reads `~/.claude/skills`. A repository can use `.cursor/skills`.
|
|
95
|
+
|
|
96
|
+
To upgrade an install from PyPI, use the tool you installed with:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
uv tool upgrade periplus-map # keeps the extras you installed
|
|
100
|
+
pipx upgrade periplus-map
|
|
101
|
+
pip install -U 'periplus-map[go,js]' # pip needs the extras named again
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Then run `periplus skills install` again, and repeat the copy above for any other agent. Read the
|
|
105
|
+
[changelog](CHANGELOG.md) before you upgrade: when a bundled rutter's version changes, update the
|
|
106
|
+
pins in your project's settings with `periplus update` and map again.
|
|
107
|
+
|
|
77
108
|
To update a local install, pull the repository and run `uv tool install /path/to/periplus` again. A
|
|
78
109
|
local directory is rebuilt when `pyproject.toml` changes or a file under `src/periplus` does. Run
|
|
79
110
|
`uv tool install --reinstall /path/to/periplus` for the form that always rebuilds. The command
|
|
@@ -174,9 +205,9 @@ An unresolved node from a map of a Drupal site, shortened:
|
|
|
174
205
|
|
|
175
206
|
Each edge has `from`, `to`, `kind`, its locations, an `occurrences` count and its provenance.
|
|
176
207
|
|
|
177
|
-
**Determinism.**
|
|
178
|
-
|
|
179
|
-
|
|
208
|
+
**Determinism.** `tests/test_demo_b_map_determinism.py` maps one project in separate processes
|
|
209
|
+
under different hash seeds and locales, and the maps are byte-identical. This ran on one Linux
|
|
210
|
+
machine. The design aims for identical maps across machines, but no test has
|
|
180
211
|
compared two machines or two operating systems yet.
|
|
181
212
|
|
|
182
213
|
### The rutters provided
|
|
@@ -184,14 +215,16 @@ compared two machines or two operating systems yet.
|
|
|
184
215
|
What the map holds depends on the rutters loaded. Bundled rutters load by name. Example rutters
|
|
185
216
|
are copied into a project's `.periplus/packs`. The tables group them by language and by framework.
|
|
186
217
|
|
|
218
|
+
[`docs/rutters.md`](docs/rutters.md) lists every bundled rutter with its dependencies.
|
|
219
|
+
|
|
187
220
|
<details>
|
|
188
221
|
<summary><strong>Languages and file types</strong></summary>
|
|
189
222
|
|
|
190
223
|
| Rutter | Version | What it finds |
|
|
191
224
|
|---|---|---|
|
|
192
|
-
| `php_basic` | 0.2.0 | PHP classes, interfaces, traits, enums, functions and methods. Inheritance, interfaces, traits, containment, and
|
|
193
|
-
| `js_basic` | 0.0.1 | JavaScript functions that have a name of their own, each under its script's path. Reads a parse tree. Needs the `js` extra. |
|
|
194
|
-
| `go_basic` | 0.0.3 | Go functions, methods, structs and interfaces, each under its package's import path. Calls written `f(x)` inside one package, and `pkg.F(x)` through an import, to another package of the module or to an unresolved function outside it. Reads a parse tree. Needs the `go` extra. |
|
|
225
|
+
| `php_basic` | 0.2.0 | PHP classes, interfaces, traits, enums, functions and methods. Inheritance, interfaces, traits, containment, properties and parameters with their types, and call sites. Plain and static calls, and method calls through a typed or assigned property; a call to a PHP builtin function makes nothing. Reads a parse tree. |
|
|
226
|
+
| `js_basic` | 0.0.1 | JavaScript scripts, and the functions that have a name of their own, each under its script's path. It reads `.js` files only and maps no calls. Reads a parse tree. Needs the `js` extra. |
|
|
227
|
+
| `go_basic` | 0.0.3 | Go functions, methods, structs and interfaces, each under its package's import path. Calls written `f(x)` inside one package, and `pkg.F(x)` through an import, to another package of the module or to an unresolved function outside it. It skips test files and `vendor`, and needs the module path in the settings as `values.module`. Reads a parse tree. Needs the `go` extra. |
|
|
195
228
|
| `yaml_basic` | 0.1.0 | Claims `.yml` and `.yaml` files for rutters that depend on it. No rules of its own. |
|
|
196
229
|
| `twig_basic` | 0.1.0 | Claims `.twig` files for rutters that depend on it. No rules of its own. |
|
|
197
230
|
|
|
@@ -217,7 +250,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
217
250
|
| `profile_basic` | 0.0.1 | Each Profile type, from its config file, as a bundle of the entity type `profile`. |
|
|
218
251
|
| `salesforce_basic` | 0.0.1 | Salesforce mapping field plugins; each mapping with its Salesforce object and its edges to the bundle, entity type and fields it maps; the Salesforce events that subscribers name. |
|
|
219
252
|
| `twig_tweak_basic` | 0.0.1 | The block plugins, menus, entity types and field storages that Twig Tweak functions such as `drupal_block('x')` name in templates. |
|
|
220
|
-
| `webform_basic` | 0.0.1 | Webform handler plugins, by annotation, and each webform, from its config file, as a bundle of `webform_submission`. |
|
|
253
|
+
| `webform_basic` | 0.0.1 | Webform handler plugins, by annotation, each joined to its class, and each webform, from its config file, as a bundle of `webform_submission`. |
|
|
221
254
|
|
|
222
255
|
</details>
|
|
223
256
|
|
|
@@ -226,7 +259,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
226
259
|
|
|
227
260
|
| Rutter | Version | What it finds |
|
|
228
261
|
|---|---|---|
|
|
229
|
-
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups,
|
|
262
|
+
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups, each joined to its controller method, its resource controller or the view it renders, controllers, models, migrations, Blade views with their includes, extends and component tags, and configuration files with the text keys of the array each returns. The views and keys that `view('x')` and `config('x.y')` calls name in PHP functions and methods. Depends on `php_basic`. Reads text, and a parse tree for the calls. |
|
|
230
263
|
|
|
231
264
|
</details>
|
|
232
265
|
|
|
@@ -277,15 +310,10 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
277
310
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
278
311
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
279
312
|
|
|
280
|
-
New in this release: `
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
`tables`, a call argument written as a class constant read through the grammar's
|
|
285
|
-
`constant_access` and `constant_declaration` keys, and a rule narrowed to one file ending by
|
|
286
|
-
`match.ending`. A rutter's `boundary` lists the framework classes the map never reads. Each one
|
|
287
|
-
an edge reaches becomes a `declared` node, and a class that descends from one may take the type
|
|
288
|
-
the list gives it. Settings `values` pass project facts, such as a Go module path, to a rutter.
|
|
313
|
+
New in this release: `periplus slice` cuts a map down to the neighbourhood of a node and
|
|
314
|
+
`periplus export` writes a map or slice as GraphML, Mermaid or DOT; `slice --direction both`
|
|
315
|
+
follows edges either way and GraphML labels name each node; and the Drupal rutter maps a route
|
|
316
|
+
name written in a PHP call to its route.
|
|
289
317
|
|
|
290
318
|
## Write a rutter
|
|
291
319
|
|
|
@@ -451,6 +479,38 @@ map holds and nothing more. `periplus check-map` runs the full schema check that
|
|
|
451
479
|
skip. The [navigation guide](docs/navigation.md) gives each command's options, output and exit
|
|
452
480
|
codes, with an example you can run.
|
|
453
481
|
|
|
482
|
+
### Slice and export
|
|
483
|
+
|
|
484
|
+
`periplus slice` writes a piece of the map to a map file of its own. `periplus export` prints the
|
|
485
|
+
whole map as GraphML, DOT or Mermaid. To draw a part of the map, slice it, then export the slice.
|
|
486
|
+
|
|
487
|
+
```
|
|
488
|
+
periplus slice [ID ...] [--path PREFIX] --out FILE [--direction out|in|both] [--depth N] [--kind K] [--limit N] [--map PATH]
|
|
489
|
+
periplus export --format graphml|dot|mermaid [--map PATH]
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
`slice` starts from the ids you name and from every node whose first file starts with `--path PREFIX`, and follows edges
|
|
493
|
+
from them. `--direction out` and `in` follow edges one way; `both` follows an edge either way at every hop (default `both`).
|
|
494
|
+
`--depth N` sets how many edges to follow (default 1), and `--kind K` keeps only edges of kind `K`;
|
|
495
|
+
repeat it for several. `--limit N` stops the slice when it would hold more than `N` items (default
|
|
496
|
+
500, `0` for no limit): the command exits 32 and writes nothing. An unknown id, or a prefix that
|
|
497
|
+
matches nothing, exits 31. `--out` is required, and a slice is a smaller map, so name it so it
|
|
498
|
+
cannot replace the full map.
|
|
499
|
+
|
|
500
|
+
`export` prints to standard output and its warnings to standard error. GraphML names each node by a generated token and carries the map id as its label, with the
|
|
501
|
+
node type and state, the edge kind, and the file and line where there is one. DOT and Mermaid
|
|
502
|
+
label each node with its id and type.
|
|
503
|
+
|
|
504
|
+
```
|
|
505
|
+
periplus slice --path src/Billing/ --out billing.map.json
|
|
506
|
+
periplus export --format graphml --map billing.map.json > billing.graphml # open in Gephi Lite
|
|
507
|
+
periplus export --format dot --map billing.map.json > billing.dot # render with Graphviz
|
|
508
|
+
periplus export --format mermaid --map billing.map.json > billing.mmd # wrap in a mermaid code fence in a pull request
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
Gephi Lite handles light graphs; use Gephi for more than about 10,000 nodes. Mermaid on GitHub may
|
|
512
|
+
not draw a graph above 500 edges or 50,000 characters, and the export warns when it passes either.
|
|
513
|
+
|
|
454
514
|
## CLI reference
|
|
455
515
|
|
|
456
516
|
Run each command in the project folder.
|
|
@@ -469,11 +529,14 @@ periplus show ID # show one node and the edges at it
|
|
|
469
529
|
periplus neighbors ID # list the items an item's edges lead to
|
|
470
530
|
periplus affected ID # list the items whose edges lead to an item
|
|
471
531
|
periplus path FROM TO # show every shortest chain of edges from one item to another
|
|
532
|
+
periplus slice ID --out FILE # write the items around some items or a path to a smaller map
|
|
533
|
+
periplus export --format F # print the map as graphml, dot or mermaid
|
|
534
|
+
periplus skills install # copy the Claude skills Periplus ships into ~/.claude/skills
|
|
472
535
|
```
|
|
473
536
|
|
|
474
537
|
`periplus validate` takes a bare `name`, or `name@version` to pick one of several copies.
|
|
475
|
-
`periplus update` leaves project-local and unknown pins as they are. Every command but `init`
|
|
476
|
-
takes `--format json`. The
|
|
538
|
+
`periplus update` leaves project-local and unknown pins as they are. Every command but `init`, `slice`
|
|
539
|
+
and `export` takes `--format json`. The nine commands that read a map take `--map PATH`; the
|
|
477
540
|
[navigation guide](docs/navigation.md) gives their other options. `periplus --version` prints the
|
|
478
541
|
installed version, and `periplus <command> --help` gives each command's options.
|
|
479
542
|
|
|
@@ -494,9 +557,11 @@ installed version, and `periplus <command> --help` gives each command's options.
|
|
|
494
557
|
|
|
495
558
|
## Tests and checks
|
|
496
559
|
|
|
497
|
-
The pytest suite
|
|
498
|
-
`scripts/demo.d` and stops at the first failure
|
|
499
|
-
|
|
560
|
+
The pytest suite tests the engine and the bundled rutters. `scripts/demo.sh` runs the acceptance
|
|
561
|
+
scripts in `scripts/demo.d` and stops at the first failure: one for each command, one for each
|
|
562
|
+
bundled stack family, and the README and guide examples. Each script maps a small project and
|
|
563
|
+
compares the result with what it expects. A person runs them at the end of a task. The CI workflow
|
|
564
|
+
behind the checks badge does not run them.
|
|
500
565
|
|
|
501
566
|
To propose a change, read [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
|
502
567
|
|
|
@@ -518,7 +583,6 @@ lists the rest, each rutter's among them.
|
|
|
518
583
|
- **An unresolved end takes its first candidate type.** For example, `pathlib.Path` becomes a
|
|
519
584
|
`python.function`. The map states a type it cannot know.
|
|
520
585
|
- **One JSON file, and every run is a full run.** There is no split map and no incremental run.
|
|
521
|
-
- **No export.** There is no GraphML, Mermaid or DOT output yet.
|
|
522
586
|
|
|
523
587
|
## License
|
|
524
588
|
|
|
@@ -25,7 +25,7 @@ classifiers = [
|
|
|
25
25
|
# Declared here and nowhere else. src/periplus/__init__.py reads it back at runtime through
|
|
26
26
|
# importlib.metadata.version(), so the number is written once and `periplus --version` prints
|
|
27
27
|
# what this file says by construction rather than by two places agreeing.
|
|
28
|
-
version = "0.
|
|
28
|
+
version = "0.4.0"
|
|
29
29
|
|
|
30
30
|
# Five runtime distributions. The count is still a decision, not an accident, and this comment
|
|
31
31
|
# said "two runtime distributions, zero transitive" until `periplus validate` needed a validator.
|
|
@@ -57,6 +57,7 @@ dependencies = [
|
|
|
57
57
|
# Pinned to the versions review runs. A local pass against a different version is not a pass.
|
|
58
58
|
dev = [
|
|
59
59
|
"pytest==9.1.1",
|
|
60
|
+
"pytest-xdist==3.8.0",
|
|
60
61
|
"mypy==2.3.1",
|
|
61
62
|
"ruff==0.15.0",
|
|
62
63
|
# jsonschema ships no py.typed, so mypy strict reports import-untyped without these stubs.
|
|
@@ -90,7 +91,7 @@ include = ["src/periplus", "LICENSE", "NOTICE", "README.md", "pyproject.toml"]
|
|
|
90
91
|
|
|
91
92
|
[tool.pytest.ini_options]
|
|
92
93
|
testpaths = ["tests"]
|
|
93
|
-
addopts = "-
|
|
94
|
+
addopts = "-n auto --durations=25 --strict-markers --strict-config"
|
|
94
95
|
# --strict-markers means an unregistered marker is an error, so it is declared here. The three
|
|
95
96
|
# install tests each build a virtualenv and are slow by nature; they run by default because
|
|
96
97
|
# installing is the packaging's whole point, and the marker exists so a tight inner
|
|
@@ -14,8 +14,9 @@ from pathlib import Path
|
|
|
14
14
|
from jsonschema import Draft202012Validator
|
|
15
15
|
|
|
16
16
|
from periplus.errors import ExitCode, HarnessError, Problem
|
|
17
|
-
from periplus.
|
|
18
|
-
from periplus.
|
|
17
|
+
from periplus.mapshared import MAP_SCHEMA
|
|
18
|
+
from periplus.navigate.mapfile import _read
|
|
19
|
+
from periplus.report import _escape, _json_problem
|
|
19
20
|
from periplus.validate import _schema
|
|
20
21
|
|
|
21
22
|
__all__ = ["RENDERERS", "CheckReport", "render_json", "render_text", "run"]
|
|
@@ -64,10 +65,7 @@ def render_json(report: CheckReport) -> str:
|
|
|
64
65
|
payload = {
|
|
65
66
|
"map": report.map_path,
|
|
66
67
|
"valid": not report.problems,
|
|
67
|
-
"problems": [
|
|
68
|
-
{"code": int(p.code), "message": p.message, "detail": dict(p.detail)}
|
|
69
|
-
for p in report.problems
|
|
70
|
-
],
|
|
68
|
+
"problems": [_json_problem(p) for p in report.problems],
|
|
71
69
|
}
|
|
72
70
|
return json.dumps(payload, sort_keys=True, indent=2, ensure_ascii=True) + "\n"
|
|
73
71
|
|