periplus-map 0.2.1__tar.gz → 0.3.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.3.0}/PKG-INFO +45 -26
- {periplus_map-0.2.1 → periplus_map-0.3.0}/README.md +43 -25
- {periplus_map-0.2.1 → periplus_map-0.3.0}/pyproject.toml +3 -2
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/cli.py +23 -0
- periplus_map-0.3.0/src/periplus/skills/periplus-gaps/SKILL.md +57 -0
- periplus_map-0.3.0/src/periplus/skills/periplus-map/SKILL.md +74 -0
- periplus_map-0.3.0/src/periplus/skills/periplus-map/references/descriptions.schema.json +43 -0
- periplus_map-0.3.0/src/periplus/skills/periplus-rutter/SKILL.md +208 -0
- periplus_map-0.3.0/src/periplus/skills_install.py +54 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/.gitignore +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/LICENSE +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/NOTICE +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/checkmap.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/schema/map.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/schema/navigation.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/schema/pack-file.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/schema/pack-manifest.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/schema/project-settings.schema.json +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/spec/engine.md +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/contract/spec/rules.md +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/detect.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/check.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/emit.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/packload.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/pattern.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/rules.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/select.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/source.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/engine/tree.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/errors.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/init.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/layout.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/manifest.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/map.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/__init__.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/find.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/ids.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/listing.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/mapfile.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/path.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/show.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/types.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/navigate/walk.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/advancedqueue_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.0}/src/periplus/packs/ai_basic@0.0.1/ai_agent/ai_agent.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.0}/src/periplus/packs/ai_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/config_pages_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/crop_basic@0.0.1/bundle/crop_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/crop_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_placement.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_placement_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_altered.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_content.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_derived.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_plugin_deriver.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_type_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/block/block_type_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/cache/cache.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/cache/cache_backend.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/component/sdc.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/component/sdc_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/component/sdc_use.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/config/config_object.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/display/display.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/display/display_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/display/display_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/entity/entity.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/entity/entity_class.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/entity/entity_save.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/entity/entity_type_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/entity/entity_type_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/field/field_instance_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/field/field_storage.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/field/field_storage_code.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/form/form.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/form/form_class.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/form/form_id.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/form/form_methods.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/hook/hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/module/module.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/module/module_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/plugin/plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/plugin/plugin_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/recommendations/recommendations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/service/service.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/service/service_autowire.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/service/service_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal@0.1.0/service/service_use.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/action/action.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/action/action_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/action/action_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/block_type/block_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/boundary/boundary_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/call/call.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/component/component.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/config/config_object.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/display/display.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/display/display_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/display/display_mode_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/entity_type/entity_type.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.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.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/form/form_id.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_theme_include.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/library/library.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/library/library_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/local_action/local_action.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/mail/mail.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/mail/mail_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/menu_link/menu_link.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/module/module.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/module/module_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/permission/permission.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/permission/permission_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/role/role.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/role/role_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/route/route.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_options.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/route/route_requirements.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/service/service.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/service/service_definition.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/template/template.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/template/template_route_link.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/theme/theme.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/theme/theme_info.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/template_suggestion.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/theme_hook.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/url/url.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_plugin.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.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.3.0}/src/periplus/packs/drupal_js_basic@0.0.1/behavior/behavior.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.0}/src/periplus/packs/drush_basic@0.0.1/command/command.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drush_basic@0.0.1/command/command_annotation.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drush_basic@0.0.1/command/command_attribute.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/drush_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/eck_basic@0.0.1/bundle/eck_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/eck_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go@0.0.2/interfaces/satisfies.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go@0.0.2/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go@0.0.2/types/find_declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go@0.0.2/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go_basic@0.0.3/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go_basic@0.0.3/rules/calls.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go_basic@0.0.3/rules/declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go_basic@0.0.3/rules/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/go_basic@0.0.3/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/js_basic@0.0.1/function/function.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/rules/classes.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/rules/config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/rules/routes.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/rules/types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/laravel_basic@0.0.5/rules/views.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/paragraphs_basic@0.0.1/bundle/paragraph_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/paragraphs_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/edges/edge_kinds.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/edges/find_calls.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/edges/find_imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/edges/find_member_access.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/edges/find_structure.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/embedded/embedded_regions.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/imports/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/resolution/excluded_tokens.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/resolution/resolution.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/types/find_declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php@0.1.0/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/edges/edge_kinds.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/edges/find_structure.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/imports/imports.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/types/find_declarations.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/php_basic@0.2.0/types/node_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/profile_basic@0.0.1/bundle/profile_bundle_config.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/profile_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/salesforce_basic@0.0.1/event/salesforce_event.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/salesforce_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping/salesforce_mapping.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.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.3.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.3.0}/src/periplus/packs/twig@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig@0.0.1/types/template.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_tweak_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/block.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/entity.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/field.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/menu.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/webform_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.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.3.0}/src/periplus/packs/yaml@0.0.1/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/yaml@0.0.1/types/find_mapping_entry.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/yaml@0.0.1/types/yaml_types.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs/yaml_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/packs.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/preflight.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/py.typed +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/report.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/resolution.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/settings.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/settings.stub.yml +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/spec.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/update.py +0 -0
- {periplus_map-0.2.1 → periplus_map-0.3.0}/src/periplus/validate.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: periplus-map
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.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.3.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.3.0
|
|
108
109
|
```
|
|
109
110
|
|
|
110
111
|
To install from a local copy of this repository:
|
|
@@ -113,6 +114,25 @@ 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
|
+
|
|
116
136
|
To update a local install, pull the repository and run `uv tool install /path/to/periplus` again. A
|
|
117
137
|
local directory is rebuilt when `pyproject.toml` changes or a file under `src/periplus` does. Run
|
|
118
138
|
`uv tool install --reinstall /path/to/periplus` for the form that always rebuilds. The command
|
|
@@ -213,9 +233,9 @@ An unresolved node from a map of a Drupal site, shortened:
|
|
|
213
233
|
|
|
214
234
|
Each edge has `from`, `to`, `kind`, its locations, an `occurrences` count and its provenance.
|
|
215
235
|
|
|
216
|
-
**Determinism.**
|
|
217
|
-
|
|
218
|
-
|
|
236
|
+
**Determinism.** `tests/test_demo_b_map_determinism.py` maps one project in separate processes
|
|
237
|
+
under different hash seeds and locales, and the maps are byte-identical. This ran on one Linux
|
|
238
|
+
machine. The design aims for identical maps across machines, but no test has
|
|
219
239
|
compared two machines or two operating systems yet.
|
|
220
240
|
|
|
221
241
|
### The rutters provided
|
|
@@ -223,14 +243,16 @@ compared two machines or two operating systems yet.
|
|
|
223
243
|
What the map holds depends on the rutters loaded. Bundled rutters load by name. Example rutters
|
|
224
244
|
are copied into a project's `.periplus/packs`. The tables group them by language and by framework.
|
|
225
245
|
|
|
246
|
+
[`docs/rutters.md`](docs/rutters.md) lists every bundled rutter with its dependencies.
|
|
247
|
+
|
|
226
248
|
<details>
|
|
227
249
|
<summary><strong>Languages and file types</strong></summary>
|
|
228
250
|
|
|
229
251
|
| Rutter | Version | What it finds |
|
|
230
252
|
|---|---|---|
|
|
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. |
|
|
253
|
+
| `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. |
|
|
254
|
+
| `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. |
|
|
255
|
+
| `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
256
|
| `yaml_basic` | 0.1.0 | Claims `.yml` and `.yaml` files for rutters that depend on it. No rules of its own. |
|
|
235
257
|
| `twig_basic` | 0.1.0 | Claims `.twig` files for rutters that depend on it. No rules of its own. |
|
|
236
258
|
|
|
@@ -256,7 +278,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
256
278
|
| `profile_basic` | 0.0.1 | Each Profile type, from its config file, as a bundle of the entity type `profile`. |
|
|
257
279
|
| `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
280
|
| `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`. |
|
|
281
|
+
| `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
282
|
|
|
261
283
|
</details>
|
|
262
284
|
|
|
@@ -265,7 +287,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
265
287
|
|
|
266
288
|
| Rutter | Version | What it finds |
|
|
267
289
|
|---|---|---|
|
|
268
|
-
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups,
|
|
290
|
+
| `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
291
|
|
|
270
292
|
</details>
|
|
271
293
|
|
|
@@ -316,15 +338,9 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
316
338
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
317
339
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
318
340
|
|
|
319
|
-
New in this release:
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
shapes: a resolution step that looks a written name up in a table the rutter declares under
|
|
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.
|
|
341
|
+
New in this release: three Claude skills, `periplus-rutter`, `periplus-map` and `periplus-gaps`,
|
|
342
|
+
installed with `periplus skills install`; steps to use them with other agents; and a page,
|
|
343
|
+
[`docs/rutters.md`](docs/rutters.md), that lists every bundled rutter.
|
|
328
344
|
|
|
329
345
|
## Write a rutter
|
|
330
346
|
|
|
@@ -508,6 +524,7 @@ periplus show ID # show one node and the edges at it
|
|
|
508
524
|
periplus neighbors ID # list the items an item's edges lead to
|
|
509
525
|
periplus affected ID # list the items whose edges lead to an item
|
|
510
526
|
periplus path FROM TO # show every shortest chain of edges from one item to another
|
|
527
|
+
periplus skills install # copy the Claude skills Periplus ships into ~/.claude/skills
|
|
511
528
|
```
|
|
512
529
|
|
|
513
530
|
`periplus validate` takes a bare `name`, or `name@version` to pick one of several copies.
|
|
@@ -533,9 +550,11 @@ installed version, and `periplus <command> --help` gives each command's options.
|
|
|
533
550
|
|
|
534
551
|
## Tests and checks
|
|
535
552
|
|
|
536
|
-
The pytest suite
|
|
537
|
-
`scripts/demo.d` and stops at the first failure
|
|
538
|
-
|
|
553
|
+
The pytest suite tests the engine and the bundled rutters. `scripts/demo.sh` runs the acceptance
|
|
554
|
+
scripts in `scripts/demo.d` and stops at the first failure: one for each command, one for each
|
|
555
|
+
bundled stack family, and the README and guide examples. Each script maps a small project and
|
|
556
|
+
compares the result with what it expects. A person runs them at the end of a task. The CI workflow
|
|
557
|
+
behind the checks badge does not run them.
|
|
539
558
|
|
|
540
559
|
To propose a change, read [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
|
541
560
|
|
|
@@ -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.3.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.3.0
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
To install from a local copy of this repository:
|
|
@@ -74,6 +74,25 @@ 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
|
+
|
|
77
96
|
To update a local install, pull the repository and run `uv tool install /path/to/periplus` again. A
|
|
78
97
|
local directory is rebuilt when `pyproject.toml` changes or a file under `src/periplus` does. Run
|
|
79
98
|
`uv tool install --reinstall /path/to/periplus` for the form that always rebuilds. The command
|
|
@@ -174,9 +193,9 @@ An unresolved node from a map of a Drupal site, shortened:
|
|
|
174
193
|
|
|
175
194
|
Each edge has `from`, `to`, `kind`, its locations, an `occurrences` count and its provenance.
|
|
176
195
|
|
|
177
|
-
**Determinism.**
|
|
178
|
-
|
|
179
|
-
|
|
196
|
+
**Determinism.** `tests/test_demo_b_map_determinism.py` maps one project in separate processes
|
|
197
|
+
under different hash seeds and locales, and the maps are byte-identical. This ran on one Linux
|
|
198
|
+
machine. The design aims for identical maps across machines, but no test has
|
|
180
199
|
compared two machines or two operating systems yet.
|
|
181
200
|
|
|
182
201
|
### The rutters provided
|
|
@@ -184,14 +203,16 @@ compared two machines or two operating systems yet.
|
|
|
184
203
|
What the map holds depends on the rutters loaded. Bundled rutters load by name. Example rutters
|
|
185
204
|
are copied into a project's `.periplus/packs`. The tables group them by language and by framework.
|
|
186
205
|
|
|
206
|
+
[`docs/rutters.md`](docs/rutters.md) lists every bundled rutter with its dependencies.
|
|
207
|
+
|
|
187
208
|
<details>
|
|
188
209
|
<summary><strong>Languages and file types</strong></summary>
|
|
189
210
|
|
|
190
211
|
| Rutter | Version | What it finds |
|
|
191
212
|
|---|---|---|
|
|
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. |
|
|
213
|
+
| `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. |
|
|
214
|
+
| `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. |
|
|
215
|
+
| `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
216
|
| `yaml_basic` | 0.1.0 | Claims `.yml` and `.yaml` files for rutters that depend on it. No rules of its own. |
|
|
196
217
|
| `twig_basic` | 0.1.0 | Claims `.twig` files for rutters that depend on it. No rules of its own. |
|
|
197
218
|
|
|
@@ -217,7 +238,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
217
238
|
| `profile_basic` | 0.0.1 | Each Profile type, from its config file, as a bundle of the entity type `profile`. |
|
|
218
239
|
| `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
240
|
| `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`. |
|
|
241
|
+
| `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
242
|
|
|
222
243
|
</details>
|
|
223
244
|
|
|
@@ -226,7 +247,7 @@ beside `drupal_basic` when the site uses that module.
|
|
|
226
247
|
|
|
227
248
|
| Rutter | Version | What it finds |
|
|
228
249
|
|---|---|---|
|
|
229
|
-
| `laravel_basic` | 0.0.5 | Laravel routes with the prefixes and names of `Route::prefix()->name()->group()` groups,
|
|
250
|
+
| `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
251
|
|
|
231
252
|
</details>
|
|
232
253
|
|
|
@@ -277,15 +298,9 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
277
298
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
278
299
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
279
300
|
|
|
280
|
-
New in this release:
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
shapes: a resolution step that looks a written name up in a table the rutter declares under
|
|
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.
|
|
301
|
+
New in this release: three Claude skills, `periplus-rutter`, `periplus-map` and `periplus-gaps`,
|
|
302
|
+
installed with `periplus skills install`; steps to use them with other agents; and a page,
|
|
303
|
+
[`docs/rutters.md`](docs/rutters.md), that lists every bundled rutter.
|
|
289
304
|
|
|
290
305
|
## Write a rutter
|
|
291
306
|
|
|
@@ -469,6 +484,7 @@ periplus show ID # show one node and the edges at it
|
|
|
469
484
|
periplus neighbors ID # list the items an item's edges lead to
|
|
470
485
|
periplus affected ID # list the items whose edges lead to an item
|
|
471
486
|
periplus path FROM TO # show every shortest chain of edges from one item to another
|
|
487
|
+
periplus skills install # copy the Claude skills Periplus ships into ~/.claude/skills
|
|
472
488
|
```
|
|
473
489
|
|
|
474
490
|
`periplus validate` takes a bare `name`, or `name@version` to pick one of several copies.
|
|
@@ -494,9 +510,11 @@ installed version, and `periplus <command> --help` gives each command's options.
|
|
|
494
510
|
|
|
495
511
|
## Tests and checks
|
|
496
512
|
|
|
497
|
-
The pytest suite
|
|
498
|
-
`scripts/demo.d` and stops at the first failure
|
|
499
|
-
|
|
513
|
+
The pytest suite tests the engine and the bundled rutters. `scripts/demo.sh` runs the acceptance
|
|
514
|
+
scripts in `scripts/demo.d` and stops at the first failure: one for each command, one for each
|
|
515
|
+
bundled stack family, and the README and guide examples. Each script maps a small project and
|
|
516
|
+
compares the result with what it expects. A person runs them at the end of a task. The CI workflow
|
|
517
|
+
behind the checks badge does not run them.
|
|
500
518
|
|
|
501
519
|
To propose a change, read [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
|
502
520
|
|
|
@@ -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.3.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
|
|
@@ -365,6 +365,17 @@ def build_parser() -> argparse.ArgumentParser:
|
|
|
365
365
|
metavar="PATH",
|
|
366
366
|
help="the project settings file to read, instead of the one the project root implies",
|
|
367
367
|
)
|
|
368
|
+
skills = subcommands.add_parser(
|
|
369
|
+
"skills",
|
|
370
|
+
help="manage the Claude skills this package ships",
|
|
371
|
+
description="Manage the Claude skills this package ships.",
|
|
372
|
+
)
|
|
373
|
+
skills_actions = skills.add_subparsers(dest="skills_command", required=True)
|
|
374
|
+
skills_actions.add_parser(
|
|
375
|
+
"install",
|
|
376
|
+
help="copy the skills into ~/.claude/skills, replacing older copies",
|
|
377
|
+
description="Copy every shipped skill into ~/.claude/skills, and stop.",
|
|
378
|
+
)
|
|
368
379
|
return parser
|
|
369
380
|
|
|
370
381
|
|
|
@@ -431,6 +442,18 @@ def main(argv: Sequence[str] | None = None) -> int:
|
|
|
431
442
|
)
|
|
432
443
|
return ExitCode.MISSING_DEPENDENCY
|
|
433
444
|
|
|
445
|
+
if args.command == "skills":
|
|
446
|
+
from periplus.skills_install import SkillsUnwritable, install_skills
|
|
447
|
+
|
|
448
|
+
try:
|
|
449
|
+
installed = install_skills(home=Path.home())
|
|
450
|
+
except SkillsUnwritable as error:
|
|
451
|
+
print(f"{parser.prog}: {error}", file=sys.stderr)
|
|
452
|
+
return error.problem().code
|
|
453
|
+
for folder in installed:
|
|
454
|
+
print(folder)
|
|
455
|
+
return ExitCode.OK
|
|
456
|
+
|
|
434
457
|
# This lazy import is load-bearing, not tidiness. `init.py` imports `_escape`
|
|
435
458
|
# from `periplus.report`, which pulls `resolution`, `settings` and `packs` behind it, so
|
|
436
459
|
# `import periplus.init` reaches both runtime distributions. At module level that would put
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: periplus-gaps
|
|
3
|
+
description: Read a Periplus map and the code behind it, list what the map lacks, and say for each gap whether it needs a new rule or a new rutter, and where that rule belongs.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Find the gaps in a map
|
|
7
|
+
|
|
8
|
+
## Standing rules
|
|
9
|
+
|
|
10
|
+
1. Rules are small and add to each other: split by rule file inside one rutter, never by adding rutters.
|
|
11
|
+
2. A rutter reads its stack in passes by depth: structure first, then one layer inside each class, then joins in the map.
|
|
12
|
+
3. There is no stack knowledge in the engine; a stack's shape is a rule in a rutter.
|
|
13
|
+
4. Write the rule and run it: probe before saying a rutter cannot, and quote the engine's message.
|
|
14
|
+
5. A rutter meant for others never names the project it was built on, in its code, rules, examples or prose.
|
|
15
|
+
|
|
16
|
+
## Where the detail lives
|
|
17
|
+
|
|
18
|
+
- [Navigation](https://github.com/camoa/periplus/blob/v0.3.0/docs/navigation.md) holds the signature, output rows and exit codes of each command used here.
|
|
19
|
+
- [Where a rule belongs](https://github.com/camoa/periplus/blob/v0.3.0/docs/map-report-guide.md#where-a-rule-belongs) and
|
|
20
|
+
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.3.0/docs/map-report-guide.md#when-a-gap-is-the-engines) hold the full choice of destination.
|
|
21
|
+
- [The rutter author guide](https://github.com/camoa/periplus/blob/v0.3.0/docs/rutter-author-guide.md) and the rutter skill hold how a rule is written and a rutter started.
|
|
22
|
+
- [Bundled rutters](https://github.com/camoa/periplus/blob/v0.3.0/docs/rutters.md) lists every rutter that ships with Periplus.
|
|
23
|
+
|
|
24
|
+
## Find the gaps
|
|
25
|
+
|
|
26
|
+
Run the steps in the project root, after `periplus map`.
|
|
27
|
+
|
|
28
|
+
1. Check the map and see what it holds. `periplus check-map` exits 0 on a valid map; fix any
|
|
29
|
+
fault it names before you read further. `periplus types` counts the node types and edge kinds.
|
|
30
|
+
2. List every node. Every id holds the text `::`, so `periplus find :: --limit 0 --format json`
|
|
31
|
+
prints all of them, each row with its id, type, state and first location. Keep the rows whose
|
|
32
|
+
state is `referenced` (a name seen, with nothing describing it) or `unresolved` (a rule looked
|
|
33
|
+
and failed). That is where a missing rule shows.
|
|
34
|
+
3. Open the file and line of each kept row and read the code; a row whose location is null has
|
|
35
|
+
none, so `periplus affected ID` names the nodes whose edges reach it, and you read those. Decide whether a rule would resolve
|
|
36
|
+
it: name the shape the rule would match and the node or edge it would emit.
|
|
37
|
+
4. Open `.periplus/descriptions.yaml`, the file the map skill describes. Count every node id in the
|
|
38
|
+
step 2 list, whichever its state, with no descriptions entry under `nodes` as a description gap to fill; a file with no `nodes` key
|
|
39
|
+
holds zero entries.
|
|
40
|
+
|
|
41
|
+
<!-- nav-run -->
|
|
42
|
+
```
|
|
43
|
+
$ periplus check-map
|
|
44
|
+
$ periplus types
|
|
45
|
+
$ periplus find :: --limit 0 --format json
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Where a rule belongs
|
|
49
|
+
|
|
50
|
+
Write the rule in the project's own rutter first: a rutter folder in the project's
|
|
51
|
+
`.periplus/packs`. When any other project on the stack could use it, move it to the bundled
|
|
52
|
+
rutter for that stack, as a new rule file or a rule added to one, once a second project needs it.
|
|
53
|
+
When no bundled rutter covers the stack at all, start a new rutter with the rutter skill, then
|
|
54
|
+
write the rule in it.
|
|
55
|
+
A gap is the engine's when the engine refuses the rule you wrote and no other rule can state the
|
|
56
|
+
shape. The test and the message to quote are in
|
|
57
|
+
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.3.0/docs/map-report-guide.md#when-a-gap-is-the-engines).
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: periplus-map
|
|
3
|
+
description: Navigate a Periplus map by the question being asked, and record what a node or edge does in the descriptions file beside the map.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Navigate a Periplus map
|
|
7
|
+
|
|
8
|
+
## Standing rules
|
|
9
|
+
|
|
10
|
+
1. A rutter grows by small rules that add to each other: split by rule file inside one rutter, never by adding rutters.
|
|
11
|
+
2. A rutter reads the code in passes by depth: structure first, then one layer inside each class, then joins in the map.
|
|
12
|
+
3. There is no stack knowledge in the engine; what a stack means lives in its rutter.
|
|
13
|
+
4. Run a rule and read the engine's message: probe before saying a rutter cannot.
|
|
14
|
+
5. A rutter meant for others never names the project it was built on, in its code, rules, examples or prose.
|
|
15
|
+
|
|
16
|
+
## Pick the command by the question
|
|
17
|
+
|
|
18
|
+
Run `periplus map` first. Then pick the one command that answers the question.
|
|
19
|
+
|
|
20
|
+
| Question | Command |
|
|
21
|
+
|---|---|
|
|
22
|
+
| What is one thing, and what are its neighbours? | `periplus show ID`, then `periplus neighbors ID` |
|
|
23
|
+
| What would a change to this thing affect? | `periplus affected ID` |
|
|
24
|
+
| What is the path between two things? | `periplus path FROM TO` |
|
|
25
|
+
| Which ids match a name? | `periplus find TEXT` |
|
|
26
|
+
| Which kinds of node and edge does the map hold? | `periplus types` |
|
|
27
|
+
|
|
28
|
+
Each command's options, output and exit codes are in [Navigation](https://github.com/camoa/periplus/blob/v0.3.0/docs/navigation.md). Take an id from
|
|
29
|
+
`periplus find` before passing it to the other commands. On the project in the Navigation
|
|
30
|
+
guide's worked example, these run as shown:
|
|
31
|
+
|
|
32
|
+
<!-- nav-run -->
|
|
33
|
+
```console
|
|
34
|
+
$ periplus types
|
|
35
|
+
$ periplus find helper
|
|
36
|
+
$ periplus show python.function::shop.tools.helper
|
|
37
|
+
$ periplus neighbors python.module::shop.cli --kind imports
|
|
38
|
+
$ periplus affected python.function::shop.tools.helper
|
|
39
|
+
$ periplus path python.module::shop.cli python.function::shop.tools.helper
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Read and write the descriptions file
|
|
43
|
+
|
|
44
|
+
The map holds ids, types and locations, not what a thing does. That text lives in
|
|
45
|
+
`.periplus/descriptions.yaml`, beside the map and never inside it. The engine neither reads nor
|
|
46
|
+
writes the file, so the map stays byte-identical from run to run. Commit it with the map.
|
|
47
|
+
|
|
48
|
+
Open the descriptions file on every navigation, and read the entry of each id the command reached.
|
|
49
|
+
|
|
50
|
+
The file has two top-level keys:
|
|
51
|
+
|
|
52
|
+
- `nodes` maps a node id to an entry.
|
|
53
|
+
- `edges` is a list of entries. An edge has no id in the map, so each entry carries `from`,
|
|
54
|
+
`kind` and `to` exactly as the map writes them.
|
|
55
|
+
|
|
56
|
+
Every entry carries `text`, one or more sentences on what the thing actually does, and `file` and
|
|
57
|
+
`line`, where you read it. When the code at that file and line no longer matches the text, read
|
|
58
|
+
the code again and rewrite the entry. The shape is in references/descriptions.schema.json.
|
|
59
|
+
|
|
60
|
+
<!-- example descriptions: .periplus/descriptions.yaml -->
|
|
61
|
+
```yaml
|
|
62
|
+
nodes:
|
|
63
|
+
python.function::shop.tools.helper:
|
|
64
|
+
text: Returns the constant 1. It reads nothing and changes nothing.
|
|
65
|
+
file: shop/tools.py
|
|
66
|
+
line: 1
|
|
67
|
+
edges:
|
|
68
|
+
- from: python.module::shop.cli
|
|
69
|
+
kind: calls
|
|
70
|
+
to: python.function::shop.tools.helper
|
|
71
|
+
text: The hello command's greet function calls helper and discards the result.
|
|
72
|
+
file: shop/cli.py
|
|
73
|
+
line: 9
|
|
74
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"title": "Periplus descriptions file",
|
|
4
|
+
"description": "The hand-written .periplus/descriptions.yaml beside the map: what a node or edge does, and where the reader read it.",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"properties": {
|
|
8
|
+
"nodes": {
|
|
9
|
+
"description": "Node id, as the map writes it, to its entry.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": { "$ref": "#/$defs/entry" }
|
|
12
|
+
},
|
|
13
|
+
"edges": {
|
|
14
|
+
"description": "Edge entries, each keyed by the edge's from, kind and to as the map writes them.",
|
|
15
|
+
"type": "array",
|
|
16
|
+
"items": {
|
|
17
|
+
"allOf": [
|
|
18
|
+
{ "$ref": "#/$defs/entry" },
|
|
19
|
+
{
|
|
20
|
+
"type": "object",
|
|
21
|
+
"required": ["from", "kind", "to"],
|
|
22
|
+
"properties": {
|
|
23
|
+
"from": { "type": "string", "minLength": 1 },
|
|
24
|
+
"kind": { "type": "string", "minLength": 1 },
|
|
25
|
+
"to": { "type": "string", "minLength": 1 }
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
]
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"$defs": {
|
|
33
|
+
"entry": {
|
|
34
|
+
"type": "object",
|
|
35
|
+
"required": ["text", "file", "line"],
|
|
36
|
+
"properties": {
|
|
37
|
+
"text": { "type": "string", "minLength": 1 },
|
|
38
|
+
"file": { "type": "string", "minLength": 1 },
|
|
39
|
+
"line": { "type": "integer", "minimum": 1 }
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|