adrian

Tracy Debugger

Recommended Posts

Hey @bernhard and anyone else who might be interested. Following up on my thoughts over here: 

Here's my first test:

cN2HuqqpHQ.gif.2dd012031f190c034de37754f9aaa2f0.gif

 

This comes from a new file which currently contains:

var getCodeSnippets = function() {
    return [
        {
          content: 'd(\\$pages->find("template=\${1:basic-page}")->each("\${2:title}"));',
          name: 'find-pages',
          tabTrigger: 'pwfind'
        }
    ]
};

 

I feel like there needs to be some thought put into how these should work and what the tabTrigger text should be. As you can see this one is about directly d() 'ing, but I am not sure whether it would be more versatile without that wrapping d(). Perhaps we could have both versions?

Maybe we also want something that simply returns:

foreach($pages->find("template=basic-page") as $p) {
    d($p);
}

 

I am really not sure what approach to take here.

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

Thanks!
 

  • Like 1

Share this post


Link to post
Share on other sites
Quote

or would you prefer being able to define your own in a file or in the config settings? 

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Share this post


Link to post
Share on other sites
15 minutes ago, pwired said:

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Sorry, not sure I understand how this makes things cross editor compatible. 

Honestly I think that all these should probably be in the core. After-all we have the actual snippets panel for you to define and use your own custom ones that others may not find useful.

  • Like 1

Share this post


Link to post
Share on other sites

ACE also comes with a bunch of predefined PHP snippets.

image.png.ff88750ba4cf40080afb8b4e82a77212.png

image.png.034b9b67403a561f549ec843b0c891f3.png

This will all be available in the next release of Tracy.

  • Like 1

Share this post


Link to post
Share on other sites
19 hours ago, bernhard said:

Maybe tracy could even be built a little differently to support 3rd party modules. Just like you did recently with the admin actions module (https://processwire.com/talk/topic/14921-admin-actions/?do=findComment&comment=173496). I'm not requesting this, I'm just thinking out loud here.

Hey @bernhard - sorry I forgot to respond to this before. This is certainly a possibility if there is demand. The advantage of course is that panel authors can maintain the codebase for their panel completely without relying on me to handle PRs etc. The downside is that new Tracy users needs to hunt around to find third-party panels so if we take this approach we'll want to make sure to list them all on a dedicated page on the docs site.

Let me know if anyone out there is interested in this.

Share this post


Link to post
Share on other sites

OK, just released a major new version: 4.12.0

 

1) New Title/View link in Dump tabs, so ID is edit link and title/name is view link

image.png.4e3e74a1eccf862d03727692811409e6.png

 

2) New PagePermissions section added to PW Info panel:

image.png.e67e362f0c591f22edc76a11e9600723.png

 

3) New PHP and custom PW autocomplete snippets added to the Console and File Editor panels. Here's one example, but there are others in the posts prior to this one showing general PHP snippets.

Currently there are two custom PW snippets: pwforeach and pwfind - I'd love to hear what you guys want to see here. If you have new snippet ideas, please take a look at: https://github.com/adrianbj/TracyDebugger/blob/master/scripts/code-snippets.js and feel free to send PRs with new additions.

UPmNZ6c7kf.gif.d0b9e73ed018e3e68fff9876f1e89159.gif

 

4) Ability to dynamically resize the font in the Console and File Editor panels with:

Increase: CTRL + +/=
Decrease: CTRL + -/_
Reset: CTRL + 0

 

5) Changes to the way the Console panel divs are structured and resized - please let me know if you see any issues with the results panel protruding beyond the bottom of the panel or any other issues. It's still not perfect, but it's breaking my brain 🙂

 

6) Some minor Tracy core updates and also general cleanup of many of the custom panels.

 

Please let me know if you have any problems with this new version, or ideas for improvements!

  • Like 4

Share this post


Link to post
Share on other sites
Quote

New PHP and custom PW autocomplete snippets added to the Console and File Editor panels

Thanks fly out for it. Going to edit some of my pages with this and report back.

  • Like 1

Share this post


Link to post
Share on other sites

Great additions as always! Thanks for the tutorial on building panels, I'll try that when I have an idea for something 🙂

9 hours ago, adrian said:

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

IMHO the best would be to have one shared file in the core and one file specific to each user, because habits are different so I think not all snippets will be helpful to everybody. On the other side it would be great (not to say necessary) to be able to define those snippets somewhere shared across multiple installs of tracy, so that we always have all our snippets available.

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

If you are happy with that idea I can try to implement that feature and do a PR

  • Like 1

Share this post


Link to post
Share on other sites
17 minutes ago, bernhard said:

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

I was actually thinking along those lines as well, but I do want to encourage PRs to main file that comes with Tracy as well.

But yeah if you want to add support for pointing to a Github gist URL, or any other URL I suppose, I think that would be a nice addition.

Share this post


Link to post
Share on other sites

I think we should be careful with those snippets. One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive. I'll see when I find time to dig into that!

  • Like 2

Share this post


Link to post
Share on other sites

Ok, I have implemented the ability to link to your own custom snippets file:

image.thumb.png.8034531982094be4c2829ecdd88a205d.png

If you're using a Github Gist, make sure you use the https://rawgit.com/ service because the raw file from Github is served without the correct mime type and won't work. 

The format of the custom snippet file is like this. Note the getCustomCodeSnippets() compared with the core snippets file which uses getCodeSnippets()

var getCustomCodeSnippets = function() {
    return [
        {
          name: "pwfind",
          content: "d(\\$pages->find(\"template=\${1:basic-page}\")->each(\"\${2:title}\"));",
          tabTrigger: "pwfind"
        },
        {
          name: "pwforeach",
          content: "foreach(\\$pages->find(\"template=\${1:basic-page}\") as \\$p) {\n\td(\\$p);\n}",
          tabTrigger: "pwforeach"
        }
    ]
};

At the moment the custom snippets file is PHP only. I don't think we will ever need other languages for this.


I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

If you want to peruse the available ACE core snippets, the best way is probably here: https://github.com/ajaxorg/ace/blob/master/lib/ace/snippets/php.snippets 

You can also check out the snippets for other languages in the parent folder of that file.

 

  • Like 3

Share this post


Link to post
Share on other sites

What do you guys think of me adding things like this:

nbGRfETAFW.gif.5e256568ee3fdda068c118c2b5bbfa18.gif

Share this post


Link to post
Share on other sites
23 minutes ago, adrian said:

What do you guys think of me adding things like this:

To be honest, I would not care too much about it (I guess). I'll have to think of it during further usage of the console. If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be). Otherwise you'd get plenty of requests to keep everything up to date, I'm afraid. But maybe others think differently...

What annoys me, though, are suggestions like this:

A11PnOr.png

Would it be somehow possible to prevent those suggestions of php functions when I actually want to access an object property/method? Thx

  • Like 1

Share this post


Link to post
Share on other sites
8 hours ago, bernhard said:

If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be).

Yeah, already done on my dev copy - all PW variables are automatically added to the autocomplete.

bFDXXA2w3E.gif.227e25a80f2a945998748d7021bdadb8.gif

 

8 hours ago, bernhard said:

What annoys me, though, are suggestions like this:

Agreed - I am working on this - I don't necessarily want to disable php autocompletions completely, but trying to tweak the triggering so it's not invasive when you don't want it.

  • Like 2

Share this post


Link to post
Share on other sites

Or perhaps this is even cleaner for the plain PW variables when they are not actually snippets:

3c5rQ1tTEV.gif.9e18aa018f149a4cd18347660d1d104d.gif

Share this post


Link to post
Share on other sites

Also just got this working, all generated automatically from the currently PW install, so it's always up-to-date.

Do you guys think you'd make use of this?

image.png.dfcf093aecb0c631d236908f56df4209.png

  • Like 5

Share this post


Link to post
Share on other sites
Quote

One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive.

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

I noticed that this editor has much lesser lag compared to other editors I use who update edited code through ftp. I like the update speed of this editor when you click on save. I also like that it shows hidden formats like empty space and new line to spot any other format that might got in when copying and pasting code from your own snippets.

The Increase: CTRL + works very nice to increase editors font size.

Also like it a lot that the editors window can sticky float anywhere in the backend window.

Quote

I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

I saw it in action when I was editing some css. I even noticed a little red box with a white cross that indicates typos made when editing. That is just great.

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

 

Share this post


Link to post
Share on other sites
13 hours ago, pwired said:

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

Agreed - I don't want either the Console panel or FileEditor panel to slow down at all - I'll make sure that any autocomplete/snippet stuff I add doesn't cause any slowdown.

Glad that in general you enjoy using these tools.

13 hours ago, pwired said:

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

The best way to change the editor color is to use the built in themes. I actually haven't included any other themes with the Tracy package, but I could easily add these and create a new module config setting so you can choose the theme - there are a lot of options - check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

  • Like 1

Share this post


Link to post
Share on other sites
Quote

check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

Hi,

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

 

image.png.8e0a7250d5554c759a66237fa74e97d1.png

 

 

Share this post


Link to post
Share on other sites
3 hours ago, pwired said:

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested. I initially went with just one theme (my favorite) because I wasn't sure how much use the Console and File Editor panels would get, but given their popularity I think it probably makes sense to include all the themes so you guys can choose what you prefer.

I guess the next question is to figure out whether you guys want to be able to adjust all ACE editor settings via a textarea with key:value pairs or whether I should provide the key settings I think you might want to adjust as dedicated fields in the module settings like I have with the tab size, type and show invisibles settings. What does everyone think?

  • Like 1

Share this post


Link to post
Share on other sites

Is this going too far having the doc comment displayed? It's a good learning tool. Maybe make it optional, or do you guys think just leave it out completely?

qtY05Agimd.thumb.gif.d6c3a62727ebce59e8d27b2ae00efdfa.gif

  • Like 1

Share this post


Link to post
Share on other sites
Quote

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

The TracyDebugger editor can sticky float anywhere and has a full screen toggle which makes it very practical,
so I guess more people are going to pick it up.
Would be nice to have a few themes because everybody experiences different colors as hard colors for the eyes to work with.
Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

  • Like 1

Share this post


Link to post
Share on other sites
2 hours ago, pwired said:

Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

Thanks but it's super easy. Just before I do I need to decide how to facilitate the various Ace settings like I mentioned above. 

  • Like 1

Share this post


Link to post
Share on other sites
8 hours ago, adrian said:

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

It doesn't look like they are massive (size), so, maybe yes, one or two more. I'm happy with the dark theme, so I am biased 🙂.

  • Like 3

Share this post


Link to post
Share on other sites
Quote

It doesn't look like they are massive (size), so, maybe yes, one or two more.

I think Kongondo has a point there. To prevent bloat creeping in, maybe it would be an idea to leave it up to the user which theme to get inside the ace-editor folder ?

In the ace-editor folder I noticed the file: theme-tomorrow_night.js

Just the possibility to let users change this file manually into another one e.g. theme-iplastic.js, and also manually edit font size, maybe that would be a bloat free solution ?

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      Learn more on my blog
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!