periplus-map 0.2.1__py3-none-any.whl

periplus/packs/salesforce_basic@0.0.1/salesforce_mapping_field/salesforce_mapping_field_annotation.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A Salesforce mapping field plugin declared by the generic Plugin docblock annotation on its class,
+# in the mapping field folder. Two rules because a rule that emits an edge emits no node. An id that
+# is not text in double quotes makes no plugin and is listed under skipped in the map report.
+
+rules:
+- rule: salesforce_mapping_field_from_annotation
+  reads: file
+  in:
+  - salesforce_mapping_field_classes
+  match:
+    annotation: Plugin
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.salesforce_mapping_field
+  confidence: declared
+- rule: salesforce_mapping_field_from_annotation_edges
+  reads: file
+  in:
+  - salesforce_mapping_field_classes
+  match:
+    annotation: Plugin
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/twig@0.0.1/pack.yaml

@@ -0,0 +1,26 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# twig pack — text only, no grammar. Written to test whether a stack with no
+# tree-sitter grammar is mappable at all.
+#
+# It has no `grammar:` block. Every rule matches text with a pattern and mints ids from the
+# captures. If this works, the floor for adding a stack is "someone writes patterns", not
+# "someone writes a grammar" — and tree-sitter becomes an optimisation for the languages
+# that have one, rather than a requirement.
+
+pack: twig
+version: 0.0.1
+depends: []
+
+folders:
+  source: ./
+
+files:
+  extensions: [twig]
+  exclude: []
+
+identity:
+  qualified_name:
+    parts: [path]
+  case_folding:
+    sensitive: [all]

periplus/packs/twig@0.0.1/types/template.yaml

@@ -0,0 +1,57 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# twig pack — the template and the names it references. Text rules only.
+#
+# `twig.reference`, not `twig.variable`, and `inferred`, not `declared`. A pattern grabs the
+# first word after {{ and cannot tell these apart:
+#
+#     {{ way }}            a variable
+#     {{ way|upper }}      a variable with a filter
+#     {{ path('front') }}  a function call
+#     {{ user.name }}      a property on an object
+#
+# A grammar would separate them; a pattern gives back `way`, `way`, `path`, `user`. So the
+# pack claims what it can actually see — a name is referenced here — and marks it inferred.
+# The alternative is calling `path` a variable, which is a wrong entry in a committed map.
+
+node_types:
+- name: twig.template
+  id_namespace: twig.template
+- name: twig.reference
+edge_kinds:
+- kind: references
+  from: twig.template
+  to: twig.reference
+rules:
+- rule: template_file
+  reads: file
+  in:
+  - source
+  match:
+    file: '*'
+    filetype: twig
+  id:
+    from: file_stem
+  emits:
+  - node:
+      type: twig.template
+  confidence: declared
+- rule: template_references
+  reads: file
+  in:
+  - source
+  match:
+    file: '*'
+    filetype: twig
+  id:
+    from: file_stem
+  emits:
+  - edge:
+      kind: references
+      from: this_node
+      to:
+        each: true
+        from: text
+        pattern: \{\{\s*(?P<var>[a-z_][a-z0-9_]*)
+        template: twig.reference::{var}
+  confidence: inferred

periplus/packs/twig_basic@0.1.0/pack.yaml

@@ -0,0 +1,11 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# The smallest template pack: it claims the twig extension and nothing else. It has no grammar, so
+# a file of this type is never parsed; a whole-file rule that names the filetype needs only the
+# file's name.
+pack: twig_basic
+version: 0.1.0
+depends: []
+
+files:
+  extensions: [twig]

periplus/packs/twig_tweak_basic@0.0.1/pack.yaml

@@ -0,0 +1,27 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# Known gaps. This pack maps the Twig functions of the contributed module Twig Tweak that name a
+# Drupal thing by a quoted first argument, each as an edge from the template that calls it:
+# drupal_block('plugin_id') to the block plugin, drupal_menu('name') to the config object
+# system.menu.<name>, drupal_entity('type', ...) and drupal_entity_form('type', ...) to the entity
+# type, and drupal_field('field', 'type', ...) to the config object field.storage.<type>.<field>.
+# Each line below was seen on real code or on a planted file.
+# - drupal_view, drupal_region, drupal_config, drupal_image, drupal_token, drupal_contextual_links
+#   and drupal_breadcrumb: no rule. The site this pack was written on calls none of them.
+# - drupal_messages() and drupal_url() name nothing a node stands for: no edge.
+# - A name held in a variable or joined from parts, as drupal_block(block_id): no edge, and no
+#   skipped row.
+# - drupal_entity('webform', 'x') and drupal_entity('block_content', 6) end at the entity type,
+#   not at the entity. A config entity named by its id, such as the webform x, is not reached.
+# - drupal_field ends at the field storage. The bundle and the field instance are not named by
+#   the call and get no edge.
+# - A Twig file not named .html.twig, such as a component's <name>.twig: no edge, since it is
+#   no template node. On the site this pack was written on, such files hold no call.
+# - A call inside a Twig comment makes nothing. A call inside a quoted text or a verbatim block
+#   still gives an edge.
+# - Two templates of one name, in two modules, are one template node, so their edges join.
+# - The text type is drupal_basic's drupal_template_text. The engine lets one text type claim
+#   the ending twig across all packs.
+pack: twig_tweak_basic
+version: 0.0.1
+depends: [drupal_basic]

periplus/packs/twig_tweak_basic@0.0.1/rules/block.yaml

@@ -0,0 +1,20 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# {{ drupal_block('plugin_id', {...}) }}: the template renders the block plugin the call names.
+
+edge_kinds:
+- kind: renders_block
+  from: drupal.template
+  to: drupal.block_plugin
+
+rules:
+- rule: block_rendered_in_template
+  reads: file
+  in: [module_root, theme_root]
+  match:
+    file: '*.html'
+    filetype: drupal_template_text
+    text: 'drupal_block\(\s*[''"](?<plugin>[^''"\s]+)[''"]'
+  id: {template: '{template_name}'}
+  emits: [{edge: {kind: renders_block, from: this_node, to: {from: {capture: plugin}}}}]
+  confidence: declared

periplus/packs/twig_tweak_basic@0.0.1/rules/entity.yaml

@@ -0,0 +1,35 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# {{ drupal_entity('entity_type', id) }} renders an entity of that type, and
+# {{ drupal_entity_form('entity_type', ...) }} renders a form of one. Each is an edge to the entity
+# type; the entity itself is named by a value the template holds at run time.
+
+edge_kinds:
+- kind: renders_entity_type
+  from: drupal.template
+  to: drupal.entity_type
+- kind: renders_entity_form
+  from: drupal.template
+  to: drupal.entity_type
+
+rules:
+- rule: entity_rendered_in_template
+  reads: file
+  in: [module_root, theme_root]
+  match:
+    file: '*.html'
+    filetype: drupal_template_text
+    text: 'drupal_entity\(\s*[''"](?<entity_type>[^''"\s]+)[''"]'
+  id: {template: '{template_name}'}
+  emits: [{edge: {kind: renders_entity_type, from: this_node, to: {from: {capture: entity_type}}}}]
+  confidence: declared
+- rule: entity_form_rendered_in_template
+  reads: file
+  in: [module_root, theme_root]
+  match:
+    file: '*.html'
+    filetype: drupal_template_text
+    text: 'drupal_entity_form\(\s*[''"](?<entity_type>[^''"\s]+)[''"]'
+  id: {template: '{template_name}'}
+  emits: [{edge: {kind: renders_entity_form, from: this_node, to: {from: {capture: entity_type}}}}]
+  confidence: declared

periplus/packs/twig_tweak_basic@0.0.1/rules/field.yaml

@@ -0,0 +1,21 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# {{ drupal_field('field_name', 'entity_type', id) }}: the template renders the field, whose storage
+# config object is field.storage.<entity_type>.<field_name>.
+
+edge_kinds:
+- kind: renders_field
+  from: drupal.template
+  to: drupal.field_storage
+
+rules:
+- rule: field_rendered_in_template
+  reads: file
+  in: [module_root, theme_root]
+  match:
+    file: '*.html'
+    filetype: drupal_template_text
+    text: 'drupal_field\(\s*[''"](?<field>[^''"\s]+)[''"]\s*,\s*[''"](?<entity_type>[^''"\s]+)[''"]'
+  id: {template: '{template_name}'}
+  emits: [{edge: {kind: renders_field, from: this_node, to: {template: 'field.storage.{entity_type}.{field}'}}}]
+  confidence: declared

periplus/packs/twig_tweak_basic@0.0.1/rules/menu.yaml

@@ -0,0 +1,21 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# {{ drupal_menu('menu_name') }}: the template renders the menu, whose config object is
+# system.menu.<menu_name>.
+
+edge_kinds:
+- kind: renders_menu
+  from: drupal.template
+  to: drupal.config_object
+
+rules:
+- rule: menu_rendered_in_template
+  reads: file
+  in: [module_root, theme_root]
+  match:
+    file: '*.html'
+    filetype: drupal_template_text
+    text: 'drupal_menu\(\s*[''"](?<menu>[^''"\s]+)[''"]'
+  id: {template: '{template_name}'}
+  emits: [{edge: {kind: renders_menu, from: this_node, to: {template: 'system.menu.{menu}'}}}]
+  confidence: declared

periplus/packs/webform_basic@0.0.1/bundle/webform_submission_bundle_config.yaml

@@ -0,0 +1,54 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A webform read from its config file as the bundle webform_submission.<id>, the id drupal_basic gives a field or
+# display of it. Two rules: the node with its label, and its edges.
+
+rules:
+- rule: bundle_webform_submission_from_config
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: webform.webform.*
+    filetype: yaml
+  id:
+    from: file_stem
+    normalize:
+    - {replace: '^webform\.webform\.', with: 'webform_submission.'}
+  emits:
+  - node:
+      type: drupal.bundle
+  - attribute:
+      name: label
+      from:
+        key: title
+  confidence: declared
+- rule: bundle_webform_submission_from_config_edges
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: webform.webform.*
+    filetype: yaml
+  id:
+    from: file_stem
+    normalize:
+    - {replace: '^webform\.webform\.', with: 'webform_submission.'}
+  emits:
+  - edge:
+      kind: configured_by
+      from: this_node
+      to:
+        from:
+          key: id
+        template: 'webform.webform.{id}'
+  - edge:
+      kind: bundle_of
+      from: this_node
+      to:
+        from:
+          key: id
+        template: 'webform_submission'
+  confidence: declared

periplus/packs/webform_basic@0.0.1/pack.yaml

@@ -0,0 +1,20 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# The Webform contributed module: its handler plugins, by annotation, each joined to its class by
+# plugin_class; and each webform, from its config file, as the bundle webform_submission.<id> with
+# its label (key title), a configured_by edge to that file and a bundle_of edge to the entity type
+# webform_submission.
+#
+# Known gaps: an id that is not text in double quotes makes no plugin and is listed under skipped.
+# A handler declared by an attribute gives nothing: this pack reads the annotation only, and the
+# attribute class was not checked against a Webform release. Webform's other plugin types, such as
+# elements and exporters, give nothing. A webform's elements, handlers and settings in its config
+# file give nothing, nor does its category or status. The entity type webform_submission is
+# declared by the module's PHP, which is not mapped, so it stays referenced.
+pack: webform_basic
+version: 0.0.1
+depends: [drupal_basic, php_basic]
+
+folders:
+  # The folder the handler manager discovers in, below a module's src folder.
+  webform_handler_classes: "{module_root}/src/Plugin/WebformHandler/**"

periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler.yaml

@@ -0,0 +1,8 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A Webform handler plugin, named by its plugin id; plugin_class joins it to its class.
+
+node_types:
+- name: drupal.webform_handler
+  parent: drupal.plugin
+  id_namespace: drupal.plugin.webform_handler

periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler_annotation.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A Webform handler plugin declared by the WebformHandler docblock annotation on its class. Two
+# rules because a rule that emits an edge emits no node. An id that is not text in double quotes
+# makes no plugin and is listed under skipped in the map report.
+
+rules:
+- rule: webform_handler_from_annotation
+  reads: file
+  in:
+  - webform_handler_classes
+  match:
+    annotation: WebformHandler
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.webform_handler
+  confidence: declared
+- rule: webform_handler_from_annotation_edges
+  reads: file
+  in:
+  - webform_handler_classes
+  match:
+    annotation: WebformHandler
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/yaml@0.0.1/pack.yaml

@@ -0,0 +1,72 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# YAML pack — SKETCH
+#
+# Written because transcribing the block_ways map found that the Drupal pack cannot open a
+# single YAML file. It declares `drupal.config_object` with
+# `find: {file: "config/sync/*.yml", …}` while `files` claims only `php` plus
+# [module, inc, install, theme, profile, engine]. No `.yml` is ever selected, so every
+# block placement, the view, the menu and the module's own info file are invisible — the
+# entire half of a Drupal codebase this tool exists to map.
+#
+# The fix is not a second `grammar:` block on the Drupal pack. A domain pack must not own a
+# language, or every domain pack that touches YAML re-declares the same grammar and they
+# drift. YAML is a pack, PHP is a pack, and Drupal depends on both — the same mechanism as
+# javascript -> react -> nextjs, used for a second language rather than a second layer.
+#
+# What follows from that: the grammar is chosen by the file's extension, and the
+# extension-to-grammar mapping belongs to whichever pack claimed the extension. A `find`
+# rule naming `file: "config/install/*.yml"` needs no grammar field — `.yml` resolves to
+# this pack's grammar because this pack claimed it. Nothing new in the format.
+#
+# Sketch, not a pack. It carries what block_ways actually needed and stops there.
+
+# ======================================================================================
+pack: yaml
+version: 0.0.1
+depends: []
+# A root of the graph, with nothing beneath it, exactly like php. There is no "language
+# pack" kind for it to be an instance of.
+# ======================================================================================
+
+grammar:
+  provider: tree-sitter
+  provider_version: "0.26.13"      # tree-sitter runtime, released 2026-08-23
+  language: yaml
+  grammar_version: "0.7.1"         # tree-sitter-yaml
+  # Pinned exactly, never a range. Node type names carry no stability guarantee across a
+  # grammar's minor release (tree-sitter issue #2611), so a range lets a rule that matched
+  # yesterday match nothing today, silently. UNVERIFIED: the two version numbers above are
+  # placeholders in the shape the other packs use. Neither has been checked against a
+  # published release, and both must be before this sketch becomes a pack.
+
+folders:
+  source: ./
+
+files:
+  extensions: [yml, yaml]
+  exclude: []
+  # YAML the language excludes nothing. Every real exclusion — a lock file, a vendored
+  # bundle, a CI cache — is a convention of some framework or one project, so it belongs to
+  # the pack or the settings file that knows the convention. Same posture as php.
+
+# --------------------------------------------------------------------------------------
+# Identity.
+#
+# A YAML file has no name inside it. Nothing in the document says what the document is
+# called, which is the opposite of PHP and the same as a React module: the path carries the
+# identity.
+#
+# So this pack mints ids from the path and stops. What a config name means — that
+# `core.entity_view_display.block_content.block_ways_note.default` is an entity view
+# display for one bundle — is Drupal's knowledge, not YAML's, and the rule that reads it
+# belongs to the Drupal pack.
+# --------------------------------------------------------------------------------------
+identity:
+  qualified_name:
+    parts:
+      - from: path
+        relative_to: project_root
+        as: file_path
+  case_folding:
+    sensitive: [all]

periplus/packs/yaml@0.0.1/types/find_mapping_entry.yaml

@@ -0,0 +1,21 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# yaml pack — finds a mapping entry. One rule.
+#
+# Emitted only where a dependent pack asks for it with a path expression, never for every
+# key in every file. `each: "services.*"` in the Drupal pack and `each: "*"` for menu links
+# are that expression, and how it is written is the open question this sketch does not
+# close.
+
+needs:
+  types: [yaml.mapping_entry]
+
+rules:
+
+  - rule: find_mapping_entry
+    reads: file
+    in: [source]
+    match: {declaration: block_mapping_pair, name_child: key}
+    id: {from: qualified_name}
+    emits: [{node: {type: yaml.mapping_entry}}]
+    confidence: declared

periplus/packs/yaml@0.0.1/types/yaml_types.yaml

@@ -0,0 +1,44 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# yaml pack — the node types and the containment edge. Kept out of pack.yaml because the
+# manifest schema refuses a manifest that also holds types.
+
+# --------------------------------------------------------------------------------------
+# Node types.
+#
+# Two, and deliberately no more. A pack that declared yaml.scalar and yaml.sequence would
+# be re-emitting the parse tree as a graph, which is a different tool. The mapping node
+# exists only so a dependent pack has something to attach a `contains` edge to when one
+# file declares several things — `block_ways.links.menu.yml` declares three menu link
+# plugins and is itself no config object.
+# --------------------------------------------------------------------------------------
+node_types:
+
+  - name: yaml.file
+    container: true
+
+  - name: yaml.mapping_entry
+    parent: yaml.file
+    container: true
+
+edge_kinds:
+
+  - kind: contains
+    from: [yaml.file, yaml.mapping_entry]
+    to:   yaml.mapping_entry
+    source: nearest_enclosing_container
+    confidence: declared
+
+# --------------------------------------------------------------------------------------
+# What this pack deliberately does not have.
+#
+# No resolution section. A YAML scalar that happens to read like a name is a string, and
+# nothing in the language makes it a reference. Every reference in a Drupal config file —
+# `plugin: block_ways_attribute`, `menu_name: block-ways-demo`, a dependency list — is
+# meaningful only because Drupal says so. Putting a name-matching rule here would fabricate
+# edges in every YAML file of every stack.
+#
+# why: this is the same failure as the global lowercased name map that fused a PHP
+#      `Exception` with an unrelated TypeScript class. Matching by shape rather than by a
+#      declared rule is how phantom edges get made.
+# --------------------------------------------------------------------------------------

periplus/packs/yaml_basic@0.1.0/pack.yaml

@@ -0,0 +1,10 @@
+$schema: "https://periplus.dev/schema/0/pack-manifest.schema.json"
+
+# The smallest YAML pack: it claims the two extensions and nothing else. A rule that names the
+# filetype yaml selects files by this list, so the claim lives here and in no rule.
+pack: yaml_basic
+version: 0.1.0
+depends: []
+
+files:
+  extensions: [yml, yaml]