Repository navigation
refactor: rename the package to esign_webforms - #18
Merged
Merged
Conversation
Move the Python package from esign/ to esign_webforms/ (app_name, pyproject
name, flit module) and give the app the title "Webform eSignatures". The
bundles follow the package: esign_webforms.{desk,control,web}.bundle.*, the
page template is esign_webforms/templates/esign_webforms.html, and every dotted
path, /api/method/ URL, import, test, tsconfig/oxlint/stylelint/vite path and
the types augment file use the new name. The managed files (flake, CI callers,
pre-commit, release-please package-name, tools project) are re-rendered by
frappe-nix sync, and nix/uv.lock and tools/uv.lock are relocked for the new
project names only.
Module names are kept (the module folder is still esign_webforms/esign and
modules.txt still lists "eSign"), so no DocType, custom field, property setter
or other record moves. hooks.py carries an override_whitelisted_methods shim
mapping the old esign.* whitelisted paths to the new ones for cached bundles,
webhooks and bookmarks; static analysis whitelists esign.* for those keys.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SvdEeMiewirZ3ifFoUix5F
frappe-types gen-registry now reads the customisations from esign_webforms, so the header and the per-field source paths in types/doctypes.d.ts name the new package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SvdEeMiewirZ3ifFoUix5F
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the Frappe app package from
esigntoesign_webformsand sets the app title to Webform eSignatures.esign/toesign_webforms/:app_name,[project].name,package.jsonname, the ty source root and every dotted path, import,/api/method/URL and frontendfrappe.callmethod now use the new name.esign_webforms.desk.bundle.js,esign_webforms.control.bundle.{js,css},esign_webforms.web.bundle.{js,scss}. The signing page template is nowesign_webforms/templates/esign_webforms.html.esign_webforms/. The types augment file is nowtypes/esign_webforms.augment.d.ts.frappe-nix sync: the flake (description, dev siteesign-webforms.localhost), the CI callers'app:input, pre-commit, release-please'spackage-name(esign-webforms) and the tools project.nix/uv.lockandtools/uv.lockare relocked; only the project names change.bench get-app Avunu/esign_webforms/bench install-app esign_webforms.hooks.pyhas anoverride_whitelisted_methodsshim between# frappe-nix:rename-shim-begin esignand# frappe-nix:rename-shim-end. It maps the 8 oldesign.esign.*whitelisted paths to the new ones, for cached bundles, webhooks and bookmarks. Keep it for at least one minor release. Static analysis whitelistsesign.*so it accepts the shim's old keys.Kept on purpose
eSignand the module folderesign_webforms/esign/. Kept so that no DocType, custom field, property setter or other record moves. This is why the new dotted paths readesign_webforms.esign.….esign_enabled,esign_request,esign_update_field, …), theeSignCommunication type and class names (EsignWebForm,EsignEmailTemplate). These are stored data or internal identifiers.esign-fonts.bundle.cssVite bundle and source file names such asesign_controls.ts,esign_desk.tsandesign_web.ts. These are asset or file names, not package references, and they resolve under/assets/esign_webforms/.frappe.esign_contextand the other JS globals and CSS classes. Renaming them could break custom scripts already stored on sites.CHANGELOG.mdhistory.Deploy notes
Every site that has the app installed must run the site half of the rename before
bench migrate. Otherwise migrate fails on an installed app it cannot import.apps/esign_webforms, withsites/apps.txtlistingesign_webforms).--dry-run --scanagainst a restored copy of the production database first is recommended.services.frappe-nix.sites.<site>.renamedApps = { esign = "esign_webforms"; };instead. The migrate unit then runs the site half before migrating, inside its snapshot.The open release PR for the old
esigncomponent (#13) will be superseded: release-please will open a new one underesign-webformsonce this merges. The manifest version is unchanged.🤖 Generated with Claude Code
https://claude.ai/code/session_01SvdEeMiewirZ3ifFoUix5F