René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Document some thoughts on creating config files","articleBody":"**Motivation**\r\nI have done some thinking on creating config files.\r\n\r\nSome config files can't be empty, e.g. `pre-commit` config, Bitbucket pipelines. There has to be at least one hook, pipeline step, etc. (content items).\r\n\r\nAfter some thinking, I've decided on the following principles for these sorts of functions.\r\n\r\n- If a config file has compulsory contents, then the create-file function should accept a content item as an argument\r\n- In the add-contents functions, if the file does not exist, it can be created with the content item passed as an argument.\r\n- If the config file is expected to exist (e.g. pre-commit can't install commits from an empty file) but the tool has no reason to call add-contents (e.g. we have no tools with pre-commits configured yet), then we should add a placeholder content item. Otherwise, we should not add the placeholder item.\r\n- add-contents functions should remove placeholder content items if they are detected.\r\n- Placeholder items should be named and structured as similarly as possible between config files.\r\n\r\n**Summary of desired enhancement**\r\nThe above principles should be explained more clearly and documented somewhere.\r\n","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2024-11-20T04:21:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/135/usethis-python/issues/135"}