Initial commit

Author: abose

.github/workflows/publishToPhcode.yml

@@ -0,0 +1,19 @@
+name: Publish extension to phcode.dev extension store
+# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
+on:
+  release:
+    types:
+      - edited
+      - published
+
+jobs:
+  build-tasks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        id: github_context_step
+        run: echo '${{ toJSON(github) }}'
+      - name: release details
+        run: |
+          echo "$GITHUB_REF repo=${{github.event.repository.full_name}}"
+          curl --fail-with-body https://publish.phcode.dev/publishGithubRelease?releaseRef=${{github.event.repository.full_name}}:$GITHUB_REF

.github/workflows/setupRepository.cjs

@@ -0,0 +1,67 @@
+/*
+Mainly used to setup repository default pacakge.json contents.
+You may delete this file after repo creation if not already deleted by the template setup scripts.
+*/
+
+const fs = require('fs');
+let github, context, org, repoName;
+// Include fs module
+  
+function _isValidRepoInitEvent(){
+    // create event is triggered whenever a new branch is created in the repo. so we do a hack that if the master branch
+    // of the repo is created, we consider it as repo creation as master branch is created only on repo create. This
+    // should work all the time on create from template and most of the time on external creation.
+    if(context.eventName !== 'create'){
+        return false;
+    }
+    if(!context.ref.endsWith(`/${context.payload.master_branch}`)){
+        return false;
+    }
+    return true;
+}
+
+function setupPackageJSON() {
+    let data = JSON.parse(fs.readFileSync('./package.json', {encoding:'utf8', flag:'r'}));
+    data.name = `gh-${org}-${repoName}`;
+    data.description = context.payload.repository.description || "A simple phcode.dev extension/theme.";
+    data.title = repoName;
+    data.license = context.payload.repository.license && context.payload.repository.license.name || "unknown";
+    data.author = `${context.payload.repository.owner.login}`;
+    data.homepage = context.payload.repository.html_url;
+    data.version = "0.0.1";
+  
+    fs.writeFileSync('./package.json', JSON.stringify(data, null, 4));
+    console.log("package.json file written successfully\n", data);
+}
+
+async function verifyRepoIsPublic() {
+    if(!context.payload.repository.private){
+        console.log("Repository is public, all good.");
+        return;
+    }
+    console.log("Repository must be public to publish",
+    `Repository must be public to publish the extension to the extension store.\n
+    If you want to create a private source extension, create another public repo just to create releases an publich the extension without making the source code public.`
+    );
+}
+
+async function initRepo(details){
+    github = details.github;
+    context = details.context;
+    org = details.org;
+    repoName = details.repoName;
+    console.log("github: ", JSON.stringify(github, null, 4));
+    console.log("context: ", JSON.stringify(context, null, 4));
+    if(!_isValidRepoInitEvent()){
+        console.log("Not a valid repo creation event. This task is only meant to be executed at repo creation. Exiting!");
+        return;
+    }
+    setupPackageJSON();
+    verifyRepoIsPublic();
+    
+    // cleanup
+    fs.unlinkSync('./.github/workflows/setupRepository.cjs');
+    fs.unlinkSync('./.github/workflows/setupRepository.yml');
+}
+
+module.exports.initRepo = initRepo;

.github/workflows/setupRepository.yml

@@ -0,0 +1,24 @@
+name: Setup and Init repository after create from template.
+# only to be run once. You may delete this file after the repo is created from template
+
+on:
+  create:
+
+jobs:
+  setup_repository:
+    runs-on: ubuntu-latest
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            console.log("Setting up the repository", context);
+            const org = context.payload.repository.owner.login;
+            const repoName = context.payload.repository.name;
+            const setupScript = require('.github/workflows/setupRepository.cjs');
+            setupScript.initRepo({github, context, org, repoName});
+      - uses: stefanzweifel/git-auto-commit-action@v4

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Phoenix Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,40 @@
+# Extension Template
+
+Quick start and create a new extension by using this template. Follow the below 4 steps:
+
+Refer this [link](https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes) for detailed extension docs after following the below steps:
+
+## step 1
+
+Login with github: https://github.com/login
+
+## step 2
+
+Create a new repository using this template.
+![New extension from template](https://user-images.githubusercontent.com/5336369/223931565-2708e516-a422-4e7b-9d89-9ac48c919c3d.gif)
+
+## step 3
+
+* Clone your GitHub Repo created from `step 2`. See [this link](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to lean how to clone a repository from GitHub.
+
+## step 4
+
+* Go to https://create.phcode.dev .This is a special development centric website of phcode.dev which shows non minified js/css files in the browser developer tools.
+* Open the cloned folder and select `Debug > Load Project As Extension`
+
+![image](https://user-images.githubusercontent.com/5336369/224746152-0416a862-891a-4fe1-b9dd-09add25a6cc0.png)
+
+
+* You can now make code changes to your extension and select `Debug> Reload With Extensions` to test the new code changes.
+* When you are done developing the extension/theme, select `Debug> Unload Project As Extension` to unload the extension.
+
+![image](https://user-images.githubusercontent.com/5336369/224747590-556dff1d-5b29-41c3-88a0-3ce72ab643d0.png)
+
+# Detailed Documentation
+
+Please go to https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes for more documentation/community support links.
+
+# Publishing your extension to the repository
+
+Once you have built your extension/theme, you can publish the extension to phcode.dev extension repository in a single step directly from this repo.
+Please see publish section in this link for more details: https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes

main.js

@@ -0,0 +1,43 @@
+/*global define, brackets, $ */
+
+// See detailed docs in https://github.com/phcode-dev/phoenix/wiki/How-To-Write-Extensions-And-Themes
+// A good place to look for code examples for extensions: https://github.com/phcode-dev/phoenix/tree/main/src/extensions/default
+
+// A simple extension that adds an entry in "file menu> hello world"
+define(function (require, exports, module) {
+    "use strict";
+
+    // Brackets modules
+    const AppInit = brackets.getModule("utils/AppInit"),
+        DefaultDialogs = brackets.getModule("widgets/DefaultDialogs"),
+        Dialogs = brackets.getModule("widgets/Dialogs"),
+        CommandManager = brackets.getModule("command/CommandManager"),
+        Menus = brackets.getModule("command/Menus");
+
+    // Function to run when the menu item is clicked
+    function handleHelloWorld() {
+        Dialogs.showModalDialog(
+            DefaultDialogs.DIALOG_ID_INFO,
+            "hello",
+            "world"
+        );
+    }
+    
+      // First, register a command - a UI-less object associating an id to a handler
+    var MY_COMMAND_ID = "helloworld.sayhello";   // package-style naming to avoid collisions
+    CommandManager.register("Hello World", MY_COMMAND_ID, handleHelloWorld);
+
+    // Then create a menu item bound to the command
+    // The label of the menu item is the name we gave the command (see above)
+    var menu = Menus.getMenu(Menus.AppMenuBar.FILE_MENU);
+    menu.addMenuItem(MY_COMMAND_ID);
+    
+    // We could also add a key binding at the same time:
+    //menu.addMenuItem(MY_COMMAND_ID, "Ctrl-Alt-W");
+    // (Note: "Ctrl" is automatically mapped to "Cmd" on Mac)
+    
+    // Initialize extension once shell is finished initializing.
+    AppInit.appReady(function () {
+        console.log("hello world");
+    });
+});

package.json

@@ -0,0 +1,20 @@
+{
+    "title": "Name of the extension",
+    "name": "github-<owner>-<repo>",
+    "description": "A sample extension.",
+    "version": "0.0.1",
+    "license": "MIT",
+    "author": "your name (https://github.com/<your github id>)",
+    "homepage": "<project web page url or this github repo url if no website available>",
+    "engines": {
+        "brackets": ">=2.0.0"
+    },
+    "categories": "demo",
+    "keywords": [
+        "phcode", "extension", "demo"
+    ],
+    "files": [
+        "main.js"
+    ]
+}
+