apiVersion vs branch (v1.2 vs v1.3)

Open
#43 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
lua
Domain
api

Research direction

Start with the app.apiVersion documentation in app.md and trace how scripting API properties are exposed. Define the app.features behavior for supported and unknown feature names, including the tilemap-layer example, and document or test the expected false result for nonexistent properties.

Written by the indexing model from the issue text.

Description

feature

The app.apiVersion is not a good way to check for API features when we have this branch of versions (e.g. v1.2 and v1.3). We think that we could add a new object to check features:

if app.features.hasTilemapLayers then
  ...
end

In case of a property that doesn't exist is used (e.g. app.features.nonExistentFeature) it just return false (instead of a Lua error).

Dominant language
No language data
Stars
310
Forks
68
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aseprite/api

All issues in aseprite/api

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.